fix(search): clean markdown elements in search contents

Author: Koooooo-7

package.json

@@ -36,6 +36,7 @@
     "*.js": "eslint --fix"
   },
   "dependencies": {
+    "markdown-to-txt": "^2.0.1",
     "medium-zoom": "^1.1.0",
     "opencollective-postinstall": "^2.0.2",
     "prismjs": "^1.29.0",

src/plugins/search/search.js

@@ -1,3 +1,4 @@
+import markdownToTxt from 'markdown-to-txt';
 import {
   getAndRemoveConfig,
   getAndRemoveDocisfyIgnoreConfig,
@@ -34,6 +35,13 @@ function escapeHtml(string) {
   return String(string).replace(/[&<>"']/g, s => entityMap[s]);
 }
 
+function cleanMarkdown(text) {
+  if (text) {
+    text = markdownToTxt(text);
+  }
+  return text;
+}
+
 function getAllPaths(router) {
   const paths = [];
 
@@ -226,8 +234,8 @@ export function search(query) {
 
       if (matchesScore > 0) {
         const matchingPost = {
-          title: handlePostTitle,
-          content: postContent ? resultStr : '',
+          title: cleanMarkdown(handlePostTitle),
+          content: cleanMarkdown(postContent ? resultStr : ''),
           url: postUrl,
           score: matchesScore,
         };

test/e2e/search.test.js

@@ -232,4 +232,23 @@ test.describe('Search Plugin Tests', () => {
     await page.keyboard.press('z');
     await expect(searchFieldElm).toBeFocused();
   });
+  test('search result should remove markdown', async ({ page }) => {
+    const docsifyInitConfig = {
+      markdown: {
+        homepage: `
+          # The [mock](example.com) link
+          There is lots of words.
+        `,
+      },
+      scriptURLs: ['/dist/plugins/search.js'],
+    };
+
+    const searchFieldElm = page.locator('input[type=search]');
+    const resultsHeadingElm = page.locator('.results-panel h2');
+
+    await docsifyInit(docsifyInitConfig);
+
+    await searchFieldElm.fill('There');
+    await expect(resultsHeadingElm).toHaveText('The mock link');
+  });
 });