在前端开发中，包管理工具 npm 是必不可少的一部分。而 grunt-verb 是一个基于 npm 的工具包，用来生成文档，可以帮助我们快速、方便地生成文档，并且可以自动化执行。
安装 grunt-verb
在安装 grunt-verb 之前，需要保证你已经安装了 Node.js 和 npm。安装完成后，在命令行中输入以下命令即可安装 grunt-verb：
npm install -g grunt-verb
如果你想在某个项目中使用 grunt-verb，那么在项目根目录下执行以下命令即可：
npm install grunt-verb --save-dev
使用 grunt-verb
创建一个文档
在项目中创建一个 markdown 格式的文档文件，文件名可以任意，一般以 README.md 等命名。在文档开头，必须填写以下格式的信息：
--- title: 文档标题 --- 文档内容
其中 title 表示文档的标题，可以根据需要进行修改。
配置 Gruntfile.js
在项目根目录下创建一个 Gruntfile.js 文件，并在文件中进行如下配置：
-- -------------------- ---- -------
-------------- - --------------- -
------------------
----- -
----- -
-------- -
----- -------
---- -------
---- --------------------------------------------
---- ------
------- ------------
--
---- ---------- --------------------- -------------
-
-
---
---------------------------------
----------------------------- ----------
--在配置中，dest 表示生成文件的路径，cwd 表示文档文件的路径，ver 表示当前项目的版本号，toc 表示是否在文档中生成目录，config 表示生成文档的配置文件。src 表示需要生成文档的文件。可以根据需要进行修改。
配置 .verb.json
在项目根目录下创建一个 .verb.json 文件，进行如下配置：
{
"name": "项目名称",
"version": "1.0.0",
"description": "项目描述",
"author": "作者",
"template": "templates/default.tmpl"
}在配置中，name 表示项目的名称，version 表示项目的版本号，description 表示项目的描述，author 表示作者，template 表示模板文件路径。可以根据需要进行修改。
执行命令
在命令行中执行以下命令，即可生成文档：
grunt
在执行过程中，会自动创建文件夹和文件，并生成文档。
结语
通过使用 grunt-verb 工具，我们可以快速、方便地生成文档，提高开发效率和文档质量。希望本教程对大家学习和使用 npm 包 grunt-verb 有所帮助。
示例代码
下面是一个示例代码：
-- -------------------- ---- ------- --- ------ -------- -- --- - --- -- --- --- --- ---- ------ ------ ------------- ------------------ ---------
- 无序列表
- 有序列表
引用
> 来源：[JavaScript中文网](https://www.javascriptcn.com/post/5eedaf8eb5cbfe1ea0611072) ，转载请注明来源 [https://www.javascriptcn.com/post/5eedaf8eb5cbfe1ea0611072](https://www.javascriptcn.com/post/5eedaf8eb5cbfe1ea0611072)