在前端开发中，我们经常需要处理文字信息。Markdown 是一个极为方便的文本格式，同时它也是一种很流行的文档编写方式。而在使用 Markdown 的过程中，markdown-it 是一个著名的解析器，它支持更多的语法并可以通过插件来扩展。
在本文中，我们将介绍 markdown-it-chain 这个可以让我们更方便地使用 markdown-it 的 npm 包。我们将会详细介绍它的使用方法，并借助示例代码来演示。
什么是 markdown-it-chain？
markdown-it-chain 是一个让你在使用 markdown-it 时更加方便的工具，它可以让你通过链式调用的方式来生成一个 markdown-it 的配置，使得代码可读性更高、可维护性更好。同时，markdown-it-chain 还自带了多个快捷方法，例如快速生成目录、自动加入跳转页面等功能。
使用 markdown-it-chain，你可以通过以下代码来生成一个 markdown-it 的实例：
const MarkdownIt = require('markdown-it')
const MarkdownItChain = require('markdown-it-chain')
const md = MarkdownIt()
const mdchain = new MarkdownItChain(md)以上代码中，我们首先引入了 markdown-it 和 markdown-it-chain，然后创建了一个 markdown-it 实例 md，接着使用这个实例创建了一个 markdown-it-chain 实例 mdchain。
如何使用 markdown-it-chain？
以上，我们已经创建了 markdown-it-chain 实例 mdchain。接下来，我们可以使用 mdchain 中提供的各种方法来配置 markdown-it。
基本配置
我们可以通过以下代码添加基本的 Markdown 配置：
mdchain
.options
.html(true)
.breaks(true)
.linkify(true)以上代码中，我们首先调用了 options 方法，该方法返回了一个 PluginChainer 对象，我们使用该对象来调用 html、breaks 和 linkify 方法，这些方法会将对应的选项传递给 markdown-it。这三个选项的含义分别为：
html：允许在 Markdown 中使用 HTML 标签；breaks：允许在 Markdown 中使用换行符；linkify：将文本中的 URL 自动转换为链接。
使用插件
markdown-it 支持使用插件来扩展其功能。使用 markdown-it-chain，我们可以通过以下代码来添加一个插件：
const emoji = require('markdown-it-emoji')
mdchain
.plugin(emoji)以上代码中，我们首先使用 require 引入了一个 markdown-it-emoji 插件，接着使用 plugin 方法将该插件加入到了我们的实例中。
使用快捷方法
在 markdown-it-chain 中，我们还可以使用一些快捷方法来快速生成一些 Markdown。例如，我们可以通过以下代码来生成一个目录：
mdchain
.plugin(require('markdown-it-table-of-contents'), {
markerPattern: /^\[\[toc\]\]/im,
includeLevel: [1, 2]
})以上代码中，我们首先引入了 markdown-it-table-of-contents 插件，并使用 plugin 方法将其添加到了我们的实例中。另外，我们还为该插件传递了一些配置，其中 markerPattern 和 includeLevel 分别表示目录的标记和包含的标题层级。
同时，我们还可以通过以下代码来讲内部的链接自动添加上 rel="noopener noreferrer" 属性：
mdchain
.externalLinks
.attr('target', '_blank')
.attr('rel', 'noopener noreferrer')以上代码中，我们调用了 externalLinks 方法，该方法返回了一个 ElementChainer 对象，我们使用该对象来让 markdown-it-chain 在转换链接时自动添加上指定的属性。
示例代码
我们可以通过以下代码来实际运行一下 markdown-it-chain：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- --------------- - ----------------------------
----- ----- - ----------------------------
----- -- - ------------
----- ------- - --- -------------------
--------
-----------
-------------
--------------
--------------
--------------- ---------
------------ --------- ------------
--------------
------------------------------------------------- -
-------------- -----------------
------------- --- --
--
----- -------- - -
-- --------
-------- ------------ ---- ------ - ----- ------ --------------------------------- ---- ---
------------------------
--
-------------------------------------以上代码中，我们配置了一些基础选项和插件，并使用 markdown-it-chain 渲染了一段 Markdown，同时，我们使用了 externalLinks 方法让 markdown-it-chain 在转换链接时自动添加上指定的属性。
总结
markdown-it-chain 可以让我们更加方便地使用 markdown-it，通过链式调用的方式来生成一个 markdown-it 的配置，使得代码可读性更高、可维护性更好。在本文中，我们详细介绍了 markdown-it-chain 的使用方法，并借助示例代码来演示。希望这篇文章对你开始使用 markdown-it-chain 有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/164123