feat: search ignore diacritical marks

docs/plugins.md

@@ -62,6 +62,12 @@ By default, the hyperlink on the current page is recognized and the content is s
 <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
 ```
 
+The search ignores diacritical marks by default, but is not supported by IE. If you need support, please load this `ponyfill`
+
+```html
+<script src="//polyfill.io/v3/polyfill.min.js?features=String.prototype.normalize"></script>
+```
+
 ## Google Analytics
 
 Install the plugin and configure the track id.

src/plugins/search/search.js

@@ -131,6 +131,13 @@ export function genIndex(path, content = '', router, depth) {
   return index;
 }
 
+export function ignoreDiacriticalMarks(keyword) {
+  if (keyword && keyword.normalize) {
+    return keyword.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
+  }
+  return keyword;
+}
+
 /**
  * @param {String} query Search query
  * @returns {Array} Array of results
@@ -160,14 +167,21 @@ export function search(query) {
       keywords.forEach(keyword => {
         // From https://github.com/sindresorhus/escape-string-regexp
         const regEx = new RegExp(
-          keyword.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&'),
+          ignoreDiacriticalMarks(keyword).replace(
+            /[|\\{}()[\]^$+*?.]/g,
+            '\\$&'
+          ),
           'gi'
         );
         let indexTitle = -1;
         let indexContent = -1;
 
-        indexTitle = postTitle ? postTitle.search(regEx) : -1;
-        indexContent = postContent ? postContent.search(regEx) : -1;
+        indexTitle = postTitle
+          ? ignoreDiacriticalMarks(postTitle).search(regEx)
+          : -1;
+        indexContent = postContent
+          ? ignoreDiacriticalMarks(postContent).search(regEx)
+          : -1;
 
         if (indexTitle >= 0 || indexContent >= 0) {
           matchesScore += indexTitle >= 0 ? 3 : indexContent >= 0 ? 2 : 0;
@@ -187,7 +201,7 @@ export function search(query) {
 
           const matchContent =
             '...' +
-            escapeHtml(postContent)
+            escapeHtml(ignoreDiacriticalMarks(postContent))
               .substring(start, end)
               .replace(
                 regEx,
@@ -201,7 +215,7 @@ export function search(query) {
 
       if (matchesScore > 0) {
         const matchingPost = {
-          title: escapeHtml(postTitle),
+          title: escapeHtml(ignoreDiacriticalMarks(postTitle)),
           content: postContent ? resultStr : '',
           url: postUrl,
           score: matchesScore,

test/e2e/search.test.js

@@ -105,4 +105,23 @@ describe('Search Plugin Tests', function() {
     await page.fill('input[type=search]', 'test');
     await expect(page).toEqualText('.results-panel h2', 'Test Page');
   });
+
+  test('search ignore diacritical marks', async () => {
+    const docsifyInitConfig = {
+      markdown: {
+        homepage: `
+          # Qué es
+
+          docsify genera su sitio web de documentación sobre la marcha. A diferencia de GitBook, no genera archivos estáticos html. En cambio, carga y analiza de forma inteligente sus archivos de Markdown y los muestra como sitio web. Todo lo que necesita hacer es crear un index.html para comenzar y desplegarlo en GitHub Pages.
+        `,
+      },
+      scriptURLs: ['/lib/plugins/search.min.js'],
+    };
+    await docsifyInit(docsifyInitConfig);
+    await page.fill('input[type=search]', 'documentacion');
+    await expect(page).toEqualText('.results-panel h2', 'Que es');
+    await page.click('.clear-button');
+    await page.fill('input[type=search]', 'estáticos');
+    await expect(page).toEqualText('.results-panel h2', 'Que es');
+  });
 });