markdown-it 的扩展插件

发表于 分类于 ， 阅读次数： 本文字数： 1.4k 阅读时长 ≈ 3 分钟

这些插件是 markdown-it 的扩展插件，用于增强 Markdown 的功能。以下是每个插件的功能说明和使用方法：

1. markdown-it-footnote

  • 功能：支持脚注功能。

  • 用法：

    1
    2
    3
    这是一个带有脚注的文本[^footnote]。

    [^footnote]: 这是脚注内容。

  • 效果：
    这是一个带有脚注的文本[1].

2. markdown-it-sub

  • 功能：支持下标文本。
  • 用法：
    1
    H~2~O
  • 效果：
    H2O

3. markdown-it-sup

  • 功能：支持上标文本。
  • 用法：
    1
    2^10^ = 1024
  • 效果：
    210 = 1024

4. markdown-it-deflist

  • 功能：支持定义列表。

  • 用法：

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

    术语 2
    : 定义 2

  • 效果：
    术语 1
    : 定义 1

    术语 2
    定义 2

5. markdown-it-abbr

  • 功能：支持缩写词。

  • 用法：

    1
    2
    3
    4
    *[HTML]: HyperText Markup Language
    *[W3C]: World Wide Web Consortium

    HTML 是 W3C 的标准。

  • 效果：

    HTML 是 W3C 的标准。

6. markdown-it-emoji

  • 功能：支持 Emoji 表情。
  • 用法：
    1
    :smile: :heart: :rocket:
  • 效果：
    😄 ❤️ 🚀

7. markdown-it-container

  • 功能：支持自定义容器块。

  • 用法：

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

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

  • 效果：
    ::: warning
    这是一个警告框。
    :::

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

8. markdown-it-ins

  • 功能：支持插入文本（下划线）。
  • 用法：
    1
    ++插入的文本++
  • 效果：
    插入的文本

9. markdown-it-mark

  • 功能：支持高亮文本。
  • 用法：
    1
    ==高亮的文本==
  • 效果：
    高亮的文本

10. 配置方法

在 _config.yml 中配置 hexo-renderer-markdown-it 插件时，可以启用这些插件。例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
markdown:
  render:
    html: true
    xhtmlOut: false
    breaks: true
    linkify: true
    typographer: true
    quotes: '“”‘’'
  plugins:
    - markdown-it-footnote
    - markdown-it-sub
    - markdown-it-sup
    - markdown-it-deflist
    - markdown-it-abbr
    - markdown-it-emoji
    - markdown-it-container
    - markdown-it-ins
    - markdown-it-mark

11. 安装插件

运行以下命令安装这些插件：

1
pnpm install markdown-it-footnote markdown-it-sub markdown-it-sup markdown-it-deflist markdown-it-abbr markdown-it-emoji markdown-it-container markdown-it-ins markdown-it-mark --save

12. 总结

  • 这些插件可以增强 Markdown 的功能，例如支持脚注、上下标、定义列表、Emoji 表情等。
  • 在 _config.yml 中配置 hexo-renderer-markdown-it 插件时，启用这些插件即可使用。

  1. 这是脚注内容。 ↩︎