npm 包 markdown-it-footnote 使用教程

什么是 markdown-it-footnote？

markdown-it-footnote 是一个用于在 Markdown 中添加脚注的工具包，它是基于 markdown-it 构建的。

如何安装 markdown-it-footnote？

你可以通过以下命令来安装 markdown-it-footnote：

npm install markdown-it-footnote

如何使用 markdown-it-footnote？

首先，你需要引入和初始化 markdown-it。

const MarkdownIt = require('markdown-it');
const md = new MarkdownIt();

然后，引入并使用 markdown-it-footnote 插件。

const MarkdownItFootnote = require('markdown-it-footnote');
md.use(MarkdownItFootnote);

现在，你就可以在 Markdown 文档中使用脚注了。例如：

这是一句话[^1]。

[^1]: 这是一个脚注。

在渲染为 HTML 后，脚注会显示在文本底部，并且带有超链接指向对应的脚注内容。

高级用法

除了基本的用法之外，markdown-it-footnote 还支持许多高级用法，例如自定义脚注 ID 和类名、更改默认分隔符等。

自定义脚注 ID 和类名

默认情况下，markdown-it-footnote 会根据每个脚注的位置为其生成一个唯一的 ID，并为其添加 footnote-item 类名。你可以通过以下方式自定义它们：

md.use(MarkdownItFootnote, {
  // 自定义 ID 前缀（默认为 fn）
  idPrefix: 'my-note',
  // 自定义类名（默认为 footnote-item）
  className: 'my-note-item'
});

更改默认分隔符

默认情况下，脚注内容与引用之间使用的是 : 分隔符。如果你想更改它，可以像这样做：

md.use(MarkdownItFootnote, {
  // 更改分隔符为 |
  separator: '|',
});

总结

通过本文，你应该已经掌握了如何在 Markdown 中使用 markdown-it-footnote 来添加脚注。此外，我们还介绍了一些高级用法，希望能对你有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/38941