在前端开发中，编写文档是一个很重要的环节。verb-readme-generator 是一个方便快捷地生成 README.md 文件的 npm 包，它使用模板引擎和 markdown 语法来自动生成高质量的项目文档。
本文将详细介绍 verb-readme-generator 的使用方法，并提供一些示例代码以帮助您更好地理解如何使用这个工具。
安装
要安装 verb-readme-generator，可以使用以下命令：
npm install -g verb-readme-generator
使用
初始化项目
首先，我们需要在项目根目录下创建一个 README.tmpl.md 文件，这个文件将作为模板用于生成最终的 README.md 文件。模板文件中可以包含变量、条件语句和循环语句，以便根据项目需要动态生成内容。
接着，在项目根目录下运行以下命令：
verb init
这个命令会生成一个 .verbrc.yml 配置文件，其中包含一些默认配置项，您可以根据项目需求进行修改。
执行生成
当您完成了项目文档的编写后，只需要在项目根目录下执行以下命令：
verb
这个命令会读取 .verbrc.yml 配置文件，并使用 README.tmpl.md 模板文件生成最终的 README.md 文件。
示例代码
下面是一个简单的示例，演示了如何在模板文件中使用变量和条件语句：
-- -------------------- ---- ------- - --- ---- -- -- -- ------------- - -- --- ----------- -- -- - -- -- -- ------- --- ------- --- ---- --
<% if (usage) { %>
使用方法
<%= usage %> <% } %>
-- -------------------- ---- ------- ---------------------------------------- - ------------- ------------- - ------- --------------- --- ------ ------- ------------- -------------------------------------------------- ----------- ------------------------------- -- -- ----------------------- -------- --- -------------------------------------------------- - ----------------------------------------------------------- -------- ----------------------------------------------------------------------------------