Markdonw-it

将hexo默认的markdown解释器替换为hexo-renderer-markdown-it:链接

一、配置方法

1
2
3
npm uninstall hexo-renderer-marked --save
npm install hexo-renderer-markdown-it markdown-it-abbr markdown-it-footnote markdown-it-attrs markdown-it-container markdown-it-deflist markdown-it-emoji markdown-it-ins markdown-it-mark markdown-it-sub markdown-it-sup markdown-it-anchor markdown-it-toc-done-right --save

然后在根目录中的_config.yml中添加或修改:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
markdown:
render:
html: true
xhtmlOut: false
breaks: true
linkify: true
typographer: true
plugins:
- markdown-it-abbr
- markdown-it-footnote
- markdown-it-attrs
- markdown-it-container
- markdown-it-deflist
- markdown-it-emoji
- markdown-it-ins
- markdown-it-mark
- markdown-it-sub
- markdown-it-sup
- markdown-it-anchor
- markdown-it-toc-done-right

有些插件如 anchor 和 toc-done-right 可能需要额外配置参数,具体可以在 node_modules 的文档或 GitHub 仓库中查看。

二、Demo

1. markdown-it-abbr:缩写解释

1
2
3
*[HTML]: Hyper Text Markup Language

这是一段关于 HTML 的介绍。

2. markdown-it-footnote:脚注

添加论文或文档风格的脚注。

1
2
3
这是一句话[^1]。

[^1]: 这里是脚注内容。

这是一句话[1]

3. markdown-it-attrs:给 Markdown 元素添加 HTML 属性

待补充

4. markdown-it-container:自定义块级容器

1
2
3
4
5
6
7
8
::: warning
这是一个警告提示框。
:::

::: tip
这是一个提示框。
:::

::: warning
这是一个警告提示框。
:::

::: tip
这是一个提示框。
:::

5. markdown-it-deflist:定义列表

支持 术语: 定义 形式的 Markdown 列表。

1
2
3
4
5
术语1
: 定义1

术语2
: 定义2
术语1
定义1
术语2
定义2

6. markdown-it-emoji:表情支持

简写插入emoji

1
我很开心 :smile:

我很开心 😄

7. markdown-it-ins:插入线(下划线)

支持 HTML 标签,表示插入的内容。

1
++这是插入的文字++

这是插入的文字

8. markdown-it-mark:高亮

1
==高亮内容==

高亮内容

11. markdown-it-anchor:为标题自动添加锚点

生成带链接的标题,方便生成目录或直接跳转。

如你有一个标题:

1
# 二、Demo

可以在页面通过下面的方式自动跳转

1
[跳到标题](#一、配置方法)

跳到标题

通常配合 toc 插件使用。

12. markdown-it-toc-done-right:自动生成目录(TOC)

配合 markdown-it-anchor,可以生成文章的目录。

1
[[toc]]

🡆 会生成包含当前页面各级标题的目录。(本文最开头尝试)


  1. 这里是脚注内容。 ↩︎

作者

Zhou

发布于

2025-04-25

更新于

2025-04-25

许可协议

评论

+ + +