在前端开发中，经常需要为文档生成目录，手写目录费时费力，因此使用工具自动生成目录非常方便。grunt-toc 是一个 npm 包，可以自动为 Markdown 文档生成目录，在项目中使用它可以提高效率。
安装 grunt-toc
在使用 grunt-toc 之前，需要先安装 Node.js 和 Grunt 。如果已经安装了 Node.js 和 Grunt ，则可以通过以下命令来安装 grunt-toc：
npm install -D grunt-toc
配置 Gruntfile.js 文件
在 Gruntfile.js 中配置 grunt-toc 插件。下面是一个示例配置：
-- -------------------- ---- -------
-------------- - --------------- -
------------------
---- -
-------- -
--------------- ------
------------------ ---
--
---- -----------
-
---
--------------------------------
----------------------------- ---------
--上述代码中，anchorIdPrefix 和 anchorIdSeparator 属性用于指定生成目录中锚点的前缀和分隔符，src 属性用于指定需要处理的 Markdown 文件路径。
运行 grunt-toc
运行 grunt-toc 命令即可生成目录。在 terminal 中输入以下命令：
grunt
在执行完成后，会在每个 Markdown 文件的顶部添加目录，并在每个标题下面添加相应的锚点。可以通过点击目录中的链接来快速跳转到相应的标题位置。
总结
使用 grunt-toc 可以方便地为 Markdown 文档生成目录，提高工作效率。在配置时需要注意指定正确的文件路径和锚点属性。如果有特殊需求，可以查看官方文档进行更详细的了解。
示例代码：https://github.com/gruntjs/grunt-toc
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46156