前言
在前端开发的过程中，我们常常需要编写文档以便于团队成员阅读理解，同时也需要生成 API 文档以便于其他开发者使用我们的代码。本文就介绍一款 npm 包 verb-cli ，它可以帮助我们快速编写文档和生成 API 文档。
verb-cli 简介
verb-cli 是一款基于 Node.js 的命令行工具，它可以帮助我们自动生成文档和 API 文档。它的特点如下：
- 支持多种文档格式，包括 markdown、HTML、PDF、ePub 等；
- 支持多种模板，包括 Jekyll、Handlebars、Lodash 等；
- 支持自定义模板；
- 支持自动生成 API 文档。
使用 verb-cli 可以帮助我们节省大量的时间，同时让文档更加规范和易于阅读。
安装 verb-cli
在开始使用 verb-cli 之前，我们需要先安装它。可以使用以下命令进行全局安装：
--- ------- -- --------
安装完成后，我们就可以在命令行中使用 verb 命令来生成文档和 API 文档了。
使用 verb-cli
创建项目
在使用 verb-cli 之前，我们需要先创建一个项目。可以使用以下命令创建一个名为 my-project 的项目：
----- ---------- -- -- ---------- -- --- ---- --
编写文档
在项目的根目录下创建一个名为 README.md 的文件，并添加以下内容：
- --- -- -- ---- --- ------------- ------- ------- --------- ----- ---- ---- ------- - ------------ ------- - ------------ -------- -- ---- --- ------------- -------- -------- ----- ---- ------- - ------------ -------
这就是一个简单的 API 文档。
编写配置文件
在项目的根目录下创建一个名为 .verb.md 的文件，并添加以下内容：
- ---- ------- -- -- -----------
npm install your-package-name
-- -- ----------- ----- --- ----------- - ----------------------------- ----------------------
API 文档
------------------------------- -------------------------- - ----------------- ------------- --- --- --- ---- --------------------------------
verb
----------------- --- -------- --- ---- --- ----- ---------------------------------- ----------- - -- ---------------- ----- ---- ---------- ----------------
API 文档
------------------- ---- ------------------------------------------
verb --template path/to/template
-- -- --------- -------- -------- --- ----------- ---------------------------------- ------ -------- -------------------------------- -------------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------------