在前端开发中，编写 README 是一个重要的步骤。README 是介绍项目的第一印象，可以帮助别人了解项目的特点和使用方法。本文介绍了使用 npm 包 generator-readme-cj 自动生成 README 的方法。
什么是 generator-readme-cj?
generator-readme-cj 是一个 npm 包，用于生成优美的 README。
它提供了多种 README 样式，包括基础、标准、详细等等。同时，generator-readme-cj 还支持很多附加功能，例如作者信息、项目截图、测试覆盖率等。
如何使用 generator-readme-cj?
下面是使用 generator-readme-cj 自动生成 README 的方法：
安装 generator-readme-cj
在终端中输入以下命令，全局安装 generator-readme-cj。
npm install -g generator-readme-cj
创建 README
在项目文件夹下，运行以下命令，生成 README.md 文件。
yo readme-cj
运行该命令时，会提示你输入一些项目信息，例如项目名称、作者、联系方式等等。输入后，generator-readme-cj 会根据你的输入创建README.md 文件。
查看样式
在 README.md 的根目录下，可以看到三个样式文件：basic.css、standard.css 和 details.css。按照需要选择相应的样式文件，并将样式文件链接放入 README.md 的头部。
<link rel="stylesheet" type="text/css" href="./css/basic.css">
添加内容
在 README.md 文件中，你可以使用各种 Markdown 标记添加内容。generator-readme-cj 还提供了一些附加功能，例如作者信息、项目截图、测试覆盖率等，这些内容可以使用 generator-readme-cj 内置的代码片段实现。
-- -------------------- ---- -------
-- -- -------- - --
-- ----
- ------ ------ --
- ------ ----- --
- -------- ------- --
-- - --
-- -- -------------------- - --
-- ----
-- ---------------------------------------- - --
----- ---------------- ------- --------------- ---
-- --- --
-- - --
-- -- ---------------- - --
-- -----
- -------------- ------------------------- --
- ------------ ----------------------- --
- ------------- ------------------------ --
- --------- -------------------- --
-- - --你也可以添加自定义的内容。
结束语
通过本文的介绍，你已经掌握了如何使用 generator-readme-cj 自动生成 README。使用 generator-readme-cj，可以帮助你快速创建具有统一风格的 README，提高你的开发效率。希望这篇文章能对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600556c581e8991b448d3990