介绍
markdown-it-id-and-toc 是一款基于 markdown-it 的插件，能够自动生成页面内的目录，每个标题的对应的定位点也会自动添加 id，方便跳转。markdown-it 本身是一个快速、简单的 Markdown 解析器，而 markdown-it-id-and-toc 插件则是针对目录功能进行了扩展。该插件对于开发文档和博客等场景非常有用。
本篇文章将介绍 markdown-it-id-and-toc 的使用方法，并提供详细的指导和示例代码。
安装
在开始使用 markdown-it-id-and-toc 之前，需要先安装 markdown-it 和 markdown-it-id-and-toc，因为后者是在前者的基础上进行扩展的。
npm install markdown-it markdown-it-id-and-toc --save
使用
- 首先，引入
markdown-it和markdown-it-id-and-toc：
const markdownIt = require("markdown-it");
const markdownItIdAndToc = require("markdown-it-id-and-toc");- 然后，创建
markdown-it实例，并启用markdown-it-id-and-toc：
const md = markdownIt().use(markdownItIdAndToc);
- 最后，将需要解析的 Markdown 文本传入实例中：
const result = md.render(` # 标题一 ## 标题二 ### 标题三 `);
- 解析后的 HTML 将会包含目录和标题元素，并添加了对应的
id。可以通过#+id来进行跳转。
-- -------------------- ---- -------
--- -----------------
---- --------------------------
----
----
-- -------------------
----
----
-- -------------------
----
----
-- -------------------
-----
-----
-----
-----
-----
-----
------
--- -----------------
--- -----------------配置
markdown-it-id-and-toc 可以传入一些配置项来调整生成的目录样式。
-- -------------------- ---- ------- ----- -- - ------------------------------------ - -- --------- --------- -- -- ----- ----- -- ------------- -------------------- -- ------------ ----------------- ---- -- ------------ ----------------- --- --------------------------------- -- --------------- ------------- --------- ---
完整示例
-- -------------------- ---- ------- ----- ---------- - ----------------------- ----- ------------------ - ---------------------------------- -- -- ----------- -- ----- -- - ------------------------------------ - ------------- -------------------- --- -- ------ -------- ------- ----- ------ - ----------- - --- -- --- --- --- --- --------------------
-- -------------------- ---- -------
--- -----------------
---- --------------------------
----
----
-- -------------------
----
----
-- -------------------
----
----
-- -------------------
-----
-----
-----
-----
-----
-----
------
--- -----------------
--- -----------------总结
markdown-it-id-and-toc 是一款非常实用的插件，可以为 Markdown 文档添加目录并对应生成 id，方便用户进行跳转，提高了文档的可读性和易用性。本篇文章详细介绍了该插件的安装、使用和配置的方法，希望能够帮助前端开发者更好的使用该插件，提高自己的工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005601181e8991b448de001