前言
在前端开发过程中，我们经常需要整理出一份文档供其他人阅读或者自己查阅。文档中的目录可以使我们快速定位到我们想要的内容，方便阅读。altpub-toc 是一个可以在 Markdown 文档中生成目录的 npm 包，使我们的文档更加清晰明了。
安装
在项目的根目录中执行以下命令进行安装：
npm install altpub-toc --save-dev
使用
在 Markdown 文件中添加目录
在 Markdown 文档中添加目录十分简单，只需要在想要添加目录的地方使用以下语法：
<!-- TOC --> <!-- /TOC -->
altpub-toc 会自动生成目录并插入到文档中。下面是示例代码：
-- -------------------- ---- ------- - ---- ---- --- --- - ---------------- - ---- -------------- - ---------------- ---- ---- --- -- ----- ------------------ --- --- --- ------------------- -- ----- ------------------
在这个示例中，我们使用了 TOC 的标签生成了一个包含目录的 Markdown 文档。
修改目录样式
默认情况下，altpub-toc 会使用 CSS 样式将目录渲染成一个垂直列表。但是样式可能并不符合我们的需求，我们可以自定义样式来修改目录的样式。
要为目录添加样式，请添加一个 CSS 文件到你的项目中，并在 Markdown 中添加以下行：
<!-- altpub-toc:css=/path/to/style.css -->
这里，“/path/to/style.css”应该是所添加的 CSS 样式文件的路径。在这个文件中，我们可以添加一些 CSS 样式代码来修改目录的样式。下面是一个示例：
-- -------------------- ---- ------- -- - ----------- ----- -------- -- - -- - -------------- ---- - - - ------ ----- -
修改目录层级
altpub-toc 默认会生成所有标题的目录。如果你只需要文档的一部分作为目录，你可以使用 levels 参数来指定显示哪些标题。
示例如下：
<!-- TOC:levels=2 --> <!-- /TOC -->
这里，“levels=2”表示只生成两个标题层级。
总结
altpub-toc 可以帮助我们在 Markdown 文档中生成目录，方便其他人阅读和自己查阅。除此之外，还可以自定义目录样式和目录层级。希望这个 npm 包能够给大家带来便利，尝试使用它来使你的文档更加清晰明了。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/85267