在开发前端项目时，我们经常需要编写更好的 README 文档来向用户介绍我们的项目、使用方法和 API 等信息。但是编写这些文档是很耗费时间和精力的工作，我们往往希望可以有更简单快捷的方式来生成 README 文档。这时，npm 包 pkg-2-readme 就可以帮助我们很好地解决这个问题。
什么是 pkg-2-readme？
pkg-2-readme 是一个基于 Node.js 的命令行工具，它可以通过读取 package.json 文件来自动生成项目的 README 文档。简单来说，pkg-2-readme 可以把我们的项目的一些基本信息（如项目名称、版本号、描述等）自动转化为一份格式良好的 README 文档。
如何使用 pkg-2-readme？
安装 pkg-2-readme
我们可以通过 npm 来安装 pkg-2-readme，只需要执行以下命令：
npm install pkg-2-readme -g
生成 README 文档
要使用 pkg-2-readme 生成 README 文档，我们需要进入我们的项目目录，并执行以下命令：
pkg-2-readme > README.md
此时，pkg-2-readme 将会自动生成一个包含我们项目基本信息的 README.md 文件，并输出到当前项目目录下。
自定义 README 模板
pkg-2-readme 的默认 README 模板可能无法满足我们的需求，但是我们可以使用自定义模板来生成更适合自己项目的 README 文档。我们只需要在项目目录下创建一个 readme.tpl 文件（注意这个文件名是固定的），并在其中编写我们的自定义模板即可。
pkg-2-readme 使用 EJS 作为模板引擎，因此我们可以在模板文件中使用 EJS 提供的语法来编写我们自己的模板。例如，我们可以在模板文件中添加以下代码来自定义我们的 README 头部信息：
# <%= name %> [<%= version %>] > <%= description %>
在模板中，我们可以使用以下变量：
name：项目名称。version：项目版本号。description：项目描述信息。author：项目作者信息。homepage：项目主页。license：项目所使用的开源许可证。keywords：项目关键字。
示例代码
以下是一个使用 pkg-2-readme 的示例代码：
-- -------------------- ---- ------- -- -------------- ------------ --- ------- ------------ -- -- -------------- --------- -- ------------ - --------- -- ---------- ---------- -------------- - --- ---- -- ---- ------- --- - --- ----------- -- -- ----- -- ------------- ------ ------ -- ------ -------- -- -- ------- -- ----------------- --------- -- ------------ - ---------
总结
pkg-2-readme 是一个非常方便的生成 README 文档的工具，能够帮助我们自动生成项目基本信息，并生成格式良好的 README 文档。并且，我们还可以使用自定义模板来生成适合自己项目的 README 文档。如果你还没有尝试过 pkg-2-readme，赶紧试试吧！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005738081e8991b448e9736
