feat: Support markdown-it-attrs (#174)

hexojs · Aug 30, 2022 · 1af5036 · 1af5036
1 parent 242bf09
commit 1af5036
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -248,9 +248,9 @@ markdown:
     # Minimum level for ID creation. (Ex. h2 to h6)
     level: 2
     # A suffix that is prepended to the number given if the ID is repeated.
-    collisionSuffix: ''           
+    collisionSuffix: ''
     # If `true`, creates an anchor tag with a permalink besides the heading.
-    permalink: false              
+    permalink: false
     # Class used for the permalink anchor tag.
     permalinkClass: header-anchor
     # Set to 'right' to add permalink after heading
@@ -267,6 +267,7 @@ markdown:
 
 Included plugins:
 - markdown-it-abbr
+- markdown-it-attrs
 - markdown-it-cjk-breaks
 - markdown-it-container
 - markdown-it-deflist

diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
     "hexo-util": "^2.1.0",
     "markdown-it": "^12.0.0",
     "markdown-it-abbr": "^1.0.4",
+    "markdown-it-attrs": "^4.1.3",
     "markdown-it-cjk-breaks": "^1.1.2",
     "markdown-it-container": "^3.0.0",
     "markdown-it-deflist": "^2.0.3",

diff --git a/test/fixtures/markdownit.md b/test/fixtures/markdownit.md
@@ -221,3 +221,7 @@ It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
 ::: warning
 *here be dragons*
 :::
+
+### [Attributes](https://github.com/arve0/markdown-it-attrs) { data-attr=true }
+
+This is an attribute example.
diff --git a/test/fixtures/outputs/anchors.html b/test/fixtures/outputs/anchors.html
@@ -181,3 +181,5 @@ <h3 id="Custom-containers"><a class="header-anchor" href="#Custom-containers">¶
 <p>::: warning<br>
 <em>here be dragons</em><br>
 :::</p>
+<h3 id="Attributes-data-attr-true"><a class="header-anchor" href="#Attributes-data-attr-true">¶</a><a href="https://github.com/arve0/markdown-it-attrs">Attributes</a> { data-attr=true }</h3>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/commonmark-deprecated.html b/test/fixtures/outputs/commonmark-deprecated.html
@@ -147,3 +147,5 @@ <h3><a href="https://github.com/markdown-it/markdown-it-container">Custom contai
 <p>::: warning
 <em>here be dragons</em>
 :::</p>
+<h3><a href="https://github.com/arve0/markdown-it-attrs">Attributes</a> { data-attr=true }</h3>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/commonmark.html b/test/fixtures/outputs/commonmark.html
@@ -147,3 +147,5 @@ <h3 id="Custom-containers"><a href="https://github.com/markdown-it/markdown-it-c
 <p>::: warning<br>
 <em>here be dragons</em><br>
 :::</p>
+<h3 id="Attributes-data-attr-true"><a href="https://github.com/arve0/markdown-it-attrs">Attributes</a> { data-attr=true }</h3>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/custom.html b/test/fixtures/outputs/custom.html
@@ -181,3 +181,5 @@ <h3 id="Custom-containers"><a href="https://github.com/markdown-it/markdown-it-c
 <p>::: warning<br />
 <em>here be dragons</em><br />
 :::</p>
+<h3 id="Attributes-data-attr-true"><a href="https://github.com/arve0/markdown-it-attrs">Attributes</a> { data-attr=true }</h3>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/default-disable_rules.html b/test/fixtures/outputs/default-disable_rules.html
@@ -181,3 +181,5 @@ <h3 id="Custom-containers-https-github-com-markdown-it-markdown-it-container">[C
 <p>::: warning<br>
 <em>here be dragons</em><br>
 :::</p>
+<h3 id="Attributes-https-github-com-arve0-markdown-it-attrs-data-attr-true">[Attributes](https://github.com/arve0/markdown-it-attrs) { data-attr=true }</h3>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/default.html b/test/fixtures/outputs/default.html
@@ -181,3 +181,5 @@ <h3 id="Custom-containers"><a href="https://github.com/markdown-it/markdown-it-c
 <p>::: warning<br>
 <em>here be dragons</em><br>
 :::</p>
+<h3 id="Attributes-data-attr-true"><a href="https://github.com/arve0/markdown-it-attrs">Attributes</a> { data-attr=true }</h3>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/plugins.html b/test/fixtures/outputs/plugins.html
@@ -183,6 +183,8 @@ <h3 id="Custom-containers"><a href="https://github.com/markdown-it/markdown-it-c
 <p>::: warning<br>
 <em>here be dragons</em><br>
 :::</p>
+<h3 data-attr="true" id="Attributes"><a href="https://github.com/arve0/markdown-it-attrs">Attributes</a></h3>
+<p>This is an attribute example.</p>
 <hr class="footnotes-sep">
 <section class="footnotes">
 <ol class="footnotes-list">

diff --git a/test/fixtures/outputs/zero-enable_rules.html b/test/fixtures/outputs/zero-enable_rules.html
@@ -122,3 +122,5 @@
 <p>::: warning
 *here be dragons*
 :::</p>
+<p>### <a href="https://github.com/arve0/markdown-it-attrs">Attributes</a> { data-attr=true }</p>
+<p>This is an attribute example.</p>
diff --git a/test/fixtures/outputs/zero.html b/test/fixtures/outputs/zero.html
@@ -122,3 +122,5 @@
 <p>::: warning
 *here be dragons*
 :::</p>
+<p>### [Attributes](https://github.com/arve0/markdown-it-attrs) { data-attr=true }</p>
+<p>This is an attribute example.</p>
diff --git a/test/index.js b/test/index.js
@@ -113,6 +113,7 @@ describe('Hexo Renderer Markdown-it', () => {
     it('default', () => {
       hexo.config.markdown.plugins = [
         'markdown-it-abbr',
+        'markdown-it-attrs',
         'markdown-it-container',
         'markdown-it-deflist',
         'markdown-it-emoji',