Markdown 是一种轻量级的标记语言，也是前端开发者必须掌握的技能之一。而 markdown-it-for-inline 是一个在 Markdown 中解析“行内”标记的插件，可以让我们更加方便的在 Markdown 中使用自定义的“行内”标记。
在本文中，将会详细介绍 npm 包 markdown-it-for-inline 的使用教程，包括安装、配置、使用以及示例代码和指导意义。
安装
在使用 markdown-it-for-inline 之前，我们需要先在项目中安装该 npm 包。通过以下命令可以在项目中安装 markdown-it-for-inline：
npm install markdown-it-for-inline --save
安装成功后，我们就可以开始使用 markdown-it-for-inline 了。
配置
在使用 markdown-it-for-inline 之前，我们需要先对其进行配置。在配置中，我们需要使用 markdown-it 的 use 方法将 markdown-it-for-inline 注册进来。
const markdownIt = require('markdown-it'); const markdownItForInline = require('markdown-it-for-inline'); const md = markdownIt(); md.use(markdownItForInline);
以上代码中，我们使用了 require 方法引入了 markdown-it 和 markdown-it-for-inline 两个包，并创建了一个 markdownIt 对象，最后使用 use 方法将 markdown-it-for-inline 注册进来。
使用
配置完成后，我们就可以在 Markdown 中使用 markdown-it-for-inline 提供的“行内”标记了。以一个自定义宏指令 [[toc]] 为例：
[[toc]] // 这是一个自定义宏指令，会被解析成目录
我们需要在解析时将 [[toc]] 解析成目录，可以使用 markdown-it-for-inline 提供的 markdownIt.renderer.rules 来实现。
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- ------------------- - ---------------------------------- ----- -- - ------------- ---------------------------- ---------------------- - ---------------- ---- -------- ---- - ----- ---- - -------------------- ----- ------- - ---------------- -- -------------------- - ------ ----- ----------------------------- - ------ ----- -展开代码
以上代码中，我们使用 md.renderer.rules.text 方法重写了 text 渲染方法，当我们在 Markdown 中使用 [[toc]] 标记时，该方法会被调用。
示例代码
下面是一个完整的 Markdown 文本，包含了 [[toc]] 指令和几个自定义的“行内”标记。
-- -------------------- ---- ------- - -- ---------------------- ------- --------------------------- ------------------- ---- -------------- ---- ---- ------------------- ---- ---- -------------- ---- ---- ------------- - ------------- ----展开代码
解析后会得到以下 HTML 代码：
-- -------------------- ---- ------- ----------- ----------------------------- ---- --------------------------- ---------------------------------- -------------------------- ------- -------------- -------- ------- ------------------- -------- ------- -------------- -------- ------- ------------- - ------------- --------展开代码
指导意义
使用 markdown-it-for-inline，我们可以更加方便的在 Markdown 中使用自定义的“行内”标记，可以让我们更快速地编写并且更加清晰的文档。同时，由于 Markdown 在许多地方都有广泛的应用，因此学习 markdown-it-for-inline 同样也是扩展自己技能和知识面的好机会。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66189
