feat(toc): Support unnumbered headings (#4871)

hexojs · Mar 6, 2022 · 24d8c31 · 24d8c31
1 parent 57c54f2
commit 24d8c31
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 3 deletions.
diff --git a/lib/plugins/helper/toc.js b/lib/plugins/helper/toc.js
@@ -28,7 +28,9 @@ function tocHelper(str, options = {}) {
     const { level, id, text } = el;
     const href = id ? `#${encodeURL(id)}` : null;
 
-    lastNumber[level - 1]++;
+    if (!el.unnumbered) {
+      lastNumber[level - 1]++;
+    }
 
     for (let i = level; i <= 5; i++) {
       lastNumber[i] = 0;
@@ -55,8 +57,7 @@ function tocHelper(str, options = {}) {
       result += `<a class="${className}-link">`;
     }
 
-
-    if (listNumber) {
+    if (listNumber && !el.unnumbered) {
       result += `<span class="${className}-number">`;
 
       for (let i = firstLevel - 1; i < level; i++) {

diff --git a/test/scripts/helpers/toc.js b/test/scripts/helpers/toc.js
@@ -434,4 +434,46 @@ describe('toc', () => {
 
     toc(input).should.eql('');
   });
+
+  it('unnumbered headings', () => {
+    const className = 'toc';
+
+    const input = [
+      '<h3>Title 1</h3>',
+      '<h3>Title 2</h3>',
+      '<h4>Title 2.1</h4>',
+      '<h3 data-toc-unnumbered="true">Reference</h3>'
+    ].join('');
+
+    const expected = [
+      `<ol class="${className}">`,
+      `<li class="${className}-item ${className}-level-3">`,
+      `<a class="${className}-link"><span class="${className}-number">1.</span> `,
+      `<span class="${className}-text">Title 1</span>`,
+      '</a>',
+      '</li>',
+      `<li class="${className}-item ${className}-level-3">`,
+      `<a class="${className}-link">`,
+      `<span class="${className}-number">2.</span> `,
+      `<span class="${className}-text">Title 2</span>`,
+      '</a>',
+      `<ol class="${className}-child">`,
+      `<li class="${className}-item ${className}-level-4">`,
+      `<a class="${className}-link">`,
+      `<span class="${className}-number">2.1.</span> `,
+      `<span class="${className}-text">Title 2.1</span>`,
+      '</a>',
+      '</li>',
+      '</ol>',
+      '</li>',
+      `<li class="${className}-item ${className}-level-3">`,
+      `<a class="${className}-link">`,
+      `<span class="${className}-text">Reference</span>`,
+      '</a>',
+      '</li>',
+      '</ol>'
+    ].join('');
+
+    toc(input, { list_number: true, class: className }).should.eql(expected);
+  });
 });