官方说明

以下内容翻译自官网（链接：NPM / GitHub）

hexo-renderer-markdown-it-plus

这个渲染插件使用 markdown-it 作为渲染引擎。

这个渲染插件是从 hexo-renderer-markdown-it 派生的。添加了一些插件并支持第三方 markdown-it 插件。

这是 Demo.

主要特点

安装

1
2
npm un hexo-renderer-marked --save
npm i hexo-renderer-markdown-it-plus --save

选项

配置渲染器是一个相当简单的任务，因为所有的设置都在 Hexo 的 _config.yml 文件中。您只需要在您钟爱的文本编辑器中打开它并写入您的配置。

1
2
3
4
5
6
7
8
9
10
markdown_it_plus:
    highlight: true
    html: true
    xhtmlOut: true
    breaks: true
    langPrefix:
    linkify: true
    typographer:
    quotes: “”‘’
    pre_class: highlight

Katex

Katex 插件默认启用。然而，单凭渲染器并不能使数学公式在您的网站上正确显示。因此，如果您不想使用 Katex，则不需要做任何事情。否则，如果你想使用 Katex，你必须添加这个 css 到你的网站：https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.css

高级选项

上面列出的 markdown-it 插件在默认情况下是启用的。如果你想禁用任何插件，请参考下面的配置示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
markdown_it_plus:
    highlight: true
    html: true
    xhtmlOut: true
    breaks: true
    langPrefix:
    linkify: true
    typographer:
    quotes: “”‘’
    plugins:
        - plugin:
            name: markdown-it-mark
            enable: false

默认启用的插件：

  • markdown-it-emoji
  • markdown-it-sub
  • markdown-it-sup
  • markdown-it-deflist
  • markdown-it-abbr
  • markdown-it-footnote
  • markdown-it-ins
  • markdown-it-mark
  • @iktakahiro/markdown-it-katex
  • markdown-it-toc-and-anchor

添加其他 markdown-it 插件

如果您想添加一个名为 markdown-it-something 的插件：

1.安装这个插件

1
npm install markdown-it-something --save

2.配置_config.yml

1
2
3
4
5
6
7
8
arkdown_it_plus:
    # ...
    plugins:
        - plugin:
            name: markdown-it-something
            enable: true
            options:
                # this is plugin option

日志

  • 1.0.1 Add pre_class option.
  • 1.0.2 Add highlight.js pakage to dependencies#2.
  • 1.0.3 Update katex plugin, using katex 0.9
  • 1.0.4 PR #17
  • 1.0.5 upgrade dependencies for @iktakahiro/markdown-it-katex@4.0.1, highlight.js@11.5.1, markdown-it@13.0.1, and others markdown-it plugins version…
  • 1.0.6 PR #34

关键词