在前端开发中，我们通常会使用 Markdown 进行文档撰写和展示，在 Markdown 中使用链式 API 可以使文档更加丰富和灵活。在这篇文章中，我们将介绍一个常用的 Markdown 库链式 API 工具 @gerhobbelt/markdown-it-chain 的使用教程。
什么是 @gerhobbelt/markdown-it-chain？
@gerhobbelt/markdown-it-chain 是一个链式 API 工具，它基于 markdown-it 构建，并能够在 markdown-it 解析器的基础上对 Markdown 进行更加灵活的处理。
安装
在使用 @gerhobbelt/markdown-it-chain 之前，我们需要先进行安装。可以使用 npm 或者 yarn 进行安装：
npm install @gerhobbelt/markdown-it-chain
使用方法
@gerhobbelt/markdown-it-chain 的基本使用方式如下：
-- -------------------- ---- ------- ------ --------------- ---- -------------------------------- ----- -- - --- ------------------ -- ---------- ---------- ---------- --- ----- ------ - -------------- -------- -------
在上面的代码中，我们首先通过 import 引入了 @gerhobbelt/markdown-it-chain 包，并创建了一个 MarkdownItChain 的实例。接着，我们通过 md 实例使用 plugin 方法依次调用了多个插件，最终得到了解析结果。
注册插件
@gerhobbelt/markdown-it-chain 支持多个插件注册到解析器中，让我们看一下如何注册插件。
md.use(plugin[, options])
其中，plugin 可以是一个插件函数或者一个插件数组，options 为插件的配置，可选。示例代码如下：
-- -------------------- ---- ------- ------ ------------ ---- --------------------- ------ --------- ---- -------------------------------- ----- -- - --- ------------------ -- ------------------ --------------- - -- ------- -- --- ----- ------ - -------------- -------- -------
在上面的代码中，我们分别引入了 AnchorPlugin 和 TocPlugin， 并将它们注册到了解析器中。
配置选项
我们可以使用 .options() 方法设置 Options 的选项，示例：
md
.options({
html: false, // 启用 HTML 标签在源代码中
linkify: true, // 将 URL 转换为链接
typographer: true, // 启用 typographer (如我们所知的普通的破折号 => 破折号Unicode)
})预设规则
@gerhobbelt/markdown-it-chain 支持多个预设规则，具体包含什么规则可以在源码中查看。示例：
md
.preset('default')解析
我们可以使用 .parse() 方法进行解析，示例：
const result = md.parse('your markdown text')其中，result 为解析后的 Markdown 文本。
示例
下面是一个示例，使用 @gerhobbelt/markdown-it-chain 渲染 Markdown 并实现了标题自动编号和表格目录的功能。
-- -------------------- ---- -------
------ --------------- ---- --------------------------------
------ ------------ ---- ---------------------
------ --------- ---- --------------------------------
------ --------------- ---- ------------------------
----- -- - --- ------------------
--
------------------ -
---------- -----
---------------- -----
---------------- ---
--
--------------- -
------------- --- ---
------- -------- -- -
------ ---------------------
-
--
--------------------- ------------ -
-------------- ---- --------- ---- ----- -
----- ----- - ------------
-- ------ ------- --- -- -
------------------------ -----------------
------ ----- -------------------------
- ---- -
------ -----------
-
-
--
----------
------------ ----
--
----- ------ - ----------- ------
--------------------
总结
通过本文，我们可以了解到如何使用 @gerhobbelt/markdown-it-chain 工具，以及如何注册插件、配置选项和预设规则。希望这篇文章对您的学习和开发有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f02c870403f2923b035bd74