前言
generator-template-readme 是一个基于 Yeoman 生成器的 npm 包，可以帮助开发者快速创建一个优美、规范的 README.md 文件，提高开发者的文档编写效率。本文将介绍如何使用 generator-template-readme。
前置条件
在安装完 Node.js 后，使用以下命令安装 Yeoman：
--- ------- -- --
安装
使用以下命令安装 generator-template-readme：
--- ------- -- -------------------------
使用
在需要创建 README.md 文件的目录下，使用以下命令创建文件：
-- ---------------
然后按照提示输入项目的信息，如项目名称、作者、GitHub 仓库地址等，最后将会生成一个 README.md 文件，包含以下内容：
- 项目名称
- 项目标语
- 项目描述
- 安装使用
- API 文档
- 测试
- 代码贡献指南
- 贡献者列表
- 授权许可
其中，安装使用、API 文档、测试、代码贡献指南和贡献者列表模板均已经填写好了，开发者只需要根据自己的需求修改即可。
示例代码
以下是生成的 README.md 文件的示例代码：
- ---- ---- ---- -- ---- ------- --- ------- --- -----
API 文档
方法名
方法描述
参数
| 参数 | 类型 | 描述 |
|---|---|---|
| param1 | string |
参数 1 描述 |
| param2 | number |
参数 2 描述 |
返回值
| 返回值类型 | 描述 |
|---|---|
string |
返回值描述 |
测试
--- ----
代码贡献指南
Issue 提交流程
...
Pull Request 提交流程
...
代码规范
...
贡献者列表
授权许可
-- -- --------------------------- --------------------------- --------- -------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------