什么是 grunt-doctoc
grunt-doctoc 是一个自动生成 markdown 文档目录的工具，通过运行 grunt-doctoc 可以为 markdown 文件生成对应的目录，方便阅读和导航。该工具适用于包含大量 markdown 文件的项目。
安装 grunt-doctoc
使用 npm 安装 grunt-doctoc：
npm install grunt-doctoc --save-dev
使用 grunt-doctoc
在 Gruntfile.js 中添加配置。
-- -------------------- ---- -------
------------------
------- -
-------- -
------- ----------
---------- -----
--
------ -
---- ---------- -----------------
-
-
---
-----------------------------------
----------------------------- ------------target: 可选参数，生成目录的目录，如果不设置将在源文件同目录下生成目录文件（文件名为README TOC.md），如果设置为目标目录，则将生成目录文件相对于目标目录的相对路径，即便是源目录对目标目录的相对路径。indexMode: 可选参数，是否生成 index 样式的目录文件，缺省为 false。src: 必选参数，源文件，可以使用通配符 *。
执行 grunt-doctoc：
grunt doctoc
示例代码
下面是一个示例 markdown 文件（example.md）：
-- -------------------- ---- ------- - ------- -- ------- - ----- ----- ----- --- ----- ----------- ---------- ----- -- ------- - -- ---- -- ----- ------- ---- ------- ------------ ------- ------- ---- -- ------- -- -- ------- ---------- --- --- ------- - ---- ---- ----- ----- -- ------------- -- --------- ----- ---- ------ ------ -- ------ ----- --------- --- --- ------- - --------- ---- -------- --------- --- --------- ---- -- ----- --- ------- -------- ------ ---- -- --- --------
执行 grunt-doctoc 后，生成的目录文件：
-- -------------------- ---- ------- ---- ----- ------ --- ---- --- ------ --- - ------- - -------- -------------- - -------- -------------- - ---- ------- ------------------ - ---- ------- ------------------ -- ------- - ----- ----- ----- --- ----- ----------- ---------- ----- -- ------- - -- ---- -- ----- ------- ---- ------- ------------ ------- ------- ---- -- ------- -- -- ------- ---------- --- --- ------- - ---- ---- ----- ----- -- ------------- -- --------- ----- ---- ------ ------ -- ------ ----- --------- --- --- ------- - --------- ---- -------- --------- --- --------- ---- -- ----- --- ------- -------- ------ ---- -- --- --------
通过以上的步骤，我们就可以轻松地生成 markdown 文件的目录，提高阅读体验和页面导航。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5efa00c6403f2923b035ba39