hexo-renderer-markdown-it - npm Package Compare versions

Comparing version 6.1.0 to 7.0.0

lib/renderer.js

@@ -25,3 +25,3 @@ 'use strict';
 
-    const { preset, render, enable_rules, disable_rules, plugins, anchors } = markdown;
+    const { preset, render, enable_rules, disable_rules, plugins, anchors, images } = markdown;
     this.parser = new MarkdownIt(preset, render);
@@ -49,2 +49,9 @@
     }
+
+    if (images) {
+      this.parser.use(require('./images'), {
+        images,
+        hexo: this.hexo
+      });
+    }
   }
@@ -54,3 +61,5 @@
     this.hexo.execFilterSync('markdown-it:renderer', this.parser, { context: this });
-    return this.parser.render(data.text);
+    return this.parser.render(data.text, {
+      postPath: data.path
+    });
   }
@@ -57,0 +66,0 @@ }

package.json

 {
   "name": "hexo-renderer-markdown-it",
-  "version": "6.1.0",
+  "version": "7.0.0",
   "description": "Markdown-it is a Markdown parser, done right. A faster and CommonMark compliant alternative for Hexo.",
@@ -34,4 +34,4 @@ "main": "index.js",
   "dependencies": {
-    "hexo-util": "^2.1.0",
-    "markdown-it": "^12.0.0",
+    "hexo-util": "^3.0.1",
+    "markdown-it": "^13.0.1",
     "markdown-it-abbr": "^1.0.4",
@@ -58,4 +58,4 @@ "markdown-it-attrs": "^4.1.3",
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   }
 }

README.md

@@ -5,3 +5,2 @@ # hexo-renderer-markdown-it
 [![npm version](https://badge.fury.io/js/hexo-renderer-markdown-it.svg)](https://www.npmjs.com/package/hexo-renderer-markdown-it)
-[![npm dependencies](https://david-dm.org/hexojs/hexo-renderer-markdown-it.svg)](https://david-dm.org/hexojs/hexo-renderer-markdown-it)
 [![Coverage Status](https://coveralls.io/repos/github/hexojs/hexo-renderer-markdown-it/badge.svg?branch=master)](https://coveralls.io/github/hexojs/hexo-renderer-markdown-it?branch=master)
@@ -64,2 +63,6 @@
     separator: '-'
+  images:
+    lazyload: false
+    prepend_root: false
+    post_asset: false
 ```
@@ -337,2 +340,68 @@
 
+## Frequently Asked Questions
+
+### Missing Styles of GFM Task Lists
+
+In general, adding the following styles to the theme can solve the problem.
+
+```css
+li.task-list-item {
+  list-style-type: none;
+}
+
+li.task-list-item .task-list-item-checkbox {
+  margin: 0 0.2em 0.25em -1.6em;
+}
+```
+
+### How can I add math support?
+
+First, install KaTeX plugin for markdown-it.
+
+```bash
+npm install katex @renbaoshuo/markdown-it-katex
+```
+
+Then add [`@renbaoshuo/markdown-it-katex`](https://github.com/renbaoshuo/markdown-it-katex) to plugins list.
+
+```yaml
+plugins:
+  - '@renbaoshuo/markdown-it-katex'
+  # Other plugins...
+```
+
+If you need to allow spaces before and after delimiters (e.g. `$ 1 + 1 = 2 $`), set the `skipDelimitersCheck` option to `true`:
+
+```yaml
+plugins:
+  - name: '@renbaoshuo/markdown-it-katex'
+    options:
+      skipDelimitersCheck: true
+```
+
+Don't forget to include the KaTeX stylesheet in your html:
+
+```html
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css"
+/>
+```
+
+### How can I merge table cells with the same content?
+
+Install the [`markdown-it-merge-cells`](https://github.com/Menci/markdown-it-merge-cells) plugin.
+
+```bash
+npm install markdown-it-merge-cells
+```
+
+Then add the plugin to plugins list.
+
+```yaml
+plugins:
+  - markdown-it-merge-cells
+  # Other plugins...
+```
+
 ## Requests and bug reports
@@ -339,0 +408,0 @@

No alert changes

Improved metrics

Total package byte prevSize

20548

18.75%

Number of package files

7

16.67%

Lines of code

181

37.12%

Number of lines in readme file

414

20%

Dependency changes

• + Added

  dom-serializer@2.0.0
  (transitive)

• + Added

  domhandler@5.0.3
  (transitive)

• + Added

  domutils@3.2.2
  (transitive)

• + Added

  entities@4.5.0
  (transitive)

• + Added

  hexo-util@3.3.0
  (transitive)

• + Added

  htmlparser2@9.1.0
  (transitive)

• + Added

  linkify-it@4.0.1
  (transitive)

• + Added

  markdown-it@13.0.2
  (transitive)

• - Removed

  bluebird@3.7.2
  (transitive)

• - Removed

  dom-serializer@1.4.1
  (transitive)

• - Removed

  domhandler@4.3.1
  (transitive)

• - Removed

  domutils@2.8.0
  (transitive)

• - Removed

  entities@2.1.02.2.0
  (transitive)

• - Removed

  hexo-util@2.7.0
  (transitive)

• - Removed

  htmlparser2@7.2.0
  (transitive)

• - Removed

  linkify-it@3.0.3
  (transitive)

• - Removed

  markdown-it@12.3.2
  (transitive)

• Updated

  hexo-util@^3.0.1

• Updated

  markdown-it@^13.0.1