fix: patch for docsify-ignore

Author: sy-records

docs/more-pages.md

@@ -114,24 +114,24 @@ A custom sidebar can also automatically generate a table of contents by setting
 
 ## Ignoring Subheaders
 
-When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `{docsify-ignore}` to it.
+When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `<!-- {docsify-ignore} -->` to it.
 
 ```markdown
 # Getting Started
 
-## Header {docsify-ignore}
+## Header <!-- {docsify-ignore} -->
 
 This header won't appear in the sidebar table of contents.
 ```
 
-To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on the first header of the page.
+To ignore all headers on a specific page, you can use `<!-- {docsify-ignore-all} -->` on the first header of the page.
 
 ```markdown
-# Getting Started {docsify-ignore-all}
+# Getting Started <!-- {docsify-ignore-all} -->
 
 ## Header
 
 This header won't appear in the sidebar table of contents.
 ```
 
-Both `{docsify-ignore}` and `{docsify-ignore-all}` will not be rendered on the page when used.
+Both `<!-- {docsify-ignore} -->` and `<!-- {docsify-ignore-all} -->` will not be rendered on the page when used.

src/core/render/compiler.js

@@ -214,12 +214,24 @@ export class Compiler {
         nextToc.ignoreSubHeading = true;
       }
 
+      if (/<!-- {docsify-ignore} -->/g.test(str)) {
+        str = str.replace('<!-- {docsify-ignore} -->', '');
+        nextToc.title = str;
+        nextToc.ignoreSubHeading = true;
+      }
+
       if (/{docsify-ignore-all}/g.test(str)) {
         str = str.replace('{docsify-ignore-all}', '');
         nextToc.title = str;
         nextToc.ignoreAllSubs = true;
       }
 
+      if (/<!-- {docsify-ignore-all} -->/g.test(str)) {
+        str = str.replace('<!-- {docsify-ignore-all} -->', '');
+        nextToc.title = str;
+        nextToc.ignoreAllSubs = true;
+      }
+
       const slug = slugify(config.id || str);
       const url = router.toURL(router.getCurrentPath(), { id: slug });
       nextToc.slug = url;

src/core/render/compiler/headline.js

@@ -12,12 +12,24 @@ export const headingCompiler = ({ renderer, router, _self }) =>
       nextToc.ignoreSubHeading = true;
     }
 
+    if (/<!-- {docsify-ignore} -->/g.test(str)) {
+      str = str.replace('<!-- {docsify-ignore} -->', '');
+      nextToc.title = str;
+      nextToc.ignoreSubHeading = true;
+    }
+
     if (/{docsify-ignore-all}/g.test(str)) {
       str = str.replace('{docsify-ignore-all}', '');
       nextToc.title = str;
       nextToc.ignoreAllSubs = true;
     }
 
+    if (/<!-- {docsify-ignore-all} -->/g.test(str)) {
+      str = str.replace('<!-- {docsify-ignore-all} -->', '');
+      nextToc.title = str;
+      nextToc.ignoreAllSubs = true;
+    }
+
     const slug = slugify(config.id || str);
     const url = router.toURL(router.getCurrentPath(), { id: slug });
     nextToc.slug = url;

test/unit/render.test.js

@@ -266,6 +266,22 @@ describe('render', function() {
       );
     });
 
+    it('ignore-html-comments', async function() {
+      const { docsify } = await init();
+      const output = docsify.compiler.compile(
+        '## h2 tag <!-- {docsify-ignore} -->'
+      );
+      expectSameDom(
+        output,
+        `
+        <h2 id="h2-tag">
+          <a href="#/?id=h2-tag" data-id="h2-tag" class="anchor">
+            <span>h2 tag </span>
+          </a>
+        </h2>`
+      );
+    });
+
     it('ignore-all', async function() {
       const { docsify } = await init();
       const output = docsify.compiler.compile(
@@ -286,6 +302,27 @@ describe('render', function() {
         </h2>`
       );
     });
+
+    it('ignore-all-html-comments', async function() {
+      const { docsify } = await init();
+      const output = docsify.compiler.compile(
+        `# h1 tag <!-- {docsify-ignore-all} -->` + `\n## h2 tag`
+      );
+      expectSameDom(
+        output,
+        `
+        <h1 id="h1-tag">
+          <a href="#/?id=h1-tag" data-id="h1-tag" class="anchor">
+            <span>h1 tag </span>
+          </a>
+        </h1>
+        <h2 id="h2-tag">
+          <a href="#/?id=h2-tag" data-id="h2-tag" class="anchor">
+            <span>h2 tag</span>
+          </a>
+        </h2>`
+      );
+    });
   });
 
   describe('link', function() {