什么是 gulp-doctoc?
gulp-doctoc 是一个基于 Gulp 的自动化文档生成工具，可以为 Markdown 格式的文档生成目录，并且支持多种风格定制。
安装 gulp-doctoc
在使用 gulp-doctoc 之前，需要先安装 Node.js 和 Gulp。如果已经安装了这两个工具，可以通过以下命令安装 gulp-doctoc：
npm install --save-dev gulp-doctoc
如何使用 gulp-doctoc
- 在 Gulpfile 中引入 gulp-doctoc：
const doctoc = require("gulp-doctoc");- 添加 task 到 Gulpfile：
-- -------------------- ---- -------
------------------- -------- -- -
----
----------------------
------
--------
----- -------------
------ ---
------ --
--
-
---------------------------
---- 运行 gulp task：
gulp doctoc
参数说明
mode: 指定目录生成器的模式，可选值为 "github.com"、"bitbucket.org" 或者 "nodejs.org"。默认值为 "github.com"。title: 目录的标题，如果不传递则默认为 "Table of Contents"。depth: 目录的层级深度，默认为 3。
示例代码
以下是一个简单的示例，假设我们有一个 markdown 文件 README.md，需要为其生成目录：
-- -------------------- ---- ------- ---- ----- ------ --- ---- --- ------ --- - --- -- ---- --- ----- --- ----- -- ---- - ---
在 Gulpfile 中添加以下 task：
-- -------------------- ---- -------
----- ------ - -----------------------
------------------- -------- -- -
----
-------------------
------
--------
----- -------------
------ ---
------ --
--
-
-----------------------
---运行 gulp task：
gulp doctoc
最终生成的目录如下所示：
-- -------------------- ---- ------- ---- ----- ------ --- ---- --- ------ --- - --- - ------------- - --------------- - --------------- - ------------- - ---
总结
通过使用 gulp-doctoc 工具，可以方便地为 Markdown 文档生成目录，并且支持多种风格定制。对于前端开发者来说，这是一个非常有用的工具，可以提高文档编写的效率和质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/49091