简介
npm 是一个非常常用的 JavaScript 包管理工具，通过很多 npm 包可以方便快捷的集成一些常用的功能，并且这些包都已经被测试好了，所以我们无需自己去编写这些模块，直接调用即可使用。在前端开发中，我们通常会使用一些第三方库、框架等等，为了方便其他开发者更好的了解我们的项目，我们需要编写 readme 文档来介绍项目。
readme-builder 是一个可以自动生成 npm 包 readme 文档的工具，使用起来十分方便，本篇文章将会详细介绍如何使用它。
安装
我们可以通过 npm 安装 readme-builder。
npm install -g readme-builder
使用
readme-builder 简单易用，只需要在项目根目录下新建 README.build.md 文件，按照一定格式编写文档，并执行命令即可。
示例
在项目根目录下新建 README.build.md 文件并编写以下文档
-- -------------------- ---- -------
- ----- ------ -------
- ------ ---- -- -------- ------- ------ -----
-- ------------
--- --- -- ---- -- --------
-- -----
-------------
----- ------------- - --------------------------
----- ---- - ----------------
----- ------- - -
------------ -------------------- -------------
------------- --------------
--
---------------------- ----- --------------------------- ----- ----- -- -
-- ----- -
-------------------
-------
-
------------------
---API
readmeBuilder(options, data, callback)
Generate readme file.
options: Object - Configuration options.templateDir: String - Templates path.templateFile: String - Template file name.
data: Object - Data used to compile the template.callback(err, data): Function - Callback.err: Error - Callback error.data: String - Compiled data.
在终端中执行以下命令，便可以自动生成 README.md 文件： ```bash readme-builder
结语
readme-builder 还支持自定义模板，具体可以参考官方文档。
使用 readme-builder 可以让我们更加专注于代码实现而不是文档编写，同时也可以让我们自动生成更加规范统一的 readme 文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055b8481e8991b448d918c