什么是 prettyreadme？
prettyreadme 是一款自动化的 Markdown 文档生成工具，它通过分析 npm 包中的代码，自动生成指定格式的 README.md 文件，帮助开发者节省文档编写的时间和精力。
prettyreadme 提供了多种样式，包括基本的样式和社区贡献的样式，也支持用户自定义样式。
安装
安装 prettyreadme 可以通过 npm 安装：
npm i -g prettyreadme
使用
prettyreadme 的使用非常简单，只需要在 npm 包的根目录下运行以下命令即可：
prettyreadme
prettyreadme 默认会使用基本样式生成 README.md 文件，并将其保存在根目录下。
然而，为了使生成的文档更具吸引力和价值，我们可以选择使用社区贡献的样式或者自定义样式。
使用社区样式
社区贡献了许多精美的样式，可以通过安装相应的包来使用，例如：
npm i -D prettyreadme-1
安装完成之后，在命令行输入以下命令即可生成相应样式的 README.md：
prettyreadme --style prettyreadme-1
使用自定义样式
prettyreadme 支持自定义样式。我们可以在项目根目录创建一个 .prettyreadmerc.json 配置文件，然后在其中定义自己喜欢的样式。
配置文件的一些基本参数包括：
- title：文档的标题
- desc：npm 包的描述
- repositoryName：GitHub 仓库名称
- author：作者
- license：许可证
- sections：多个章节的列表。每个章节都包含 title 和 body 属性，其中 title 是章节的标题，body 是章节的 Markdown 正文。
下面是一个例子：
-- -------------------- ---- -------
-
-------- ---------------------
------- -- ----------- ----- -- ------- ----------
----------------- -------------------------------
--------- -
------- ----- -----
-------- ----------------------
------ ---------------------
--
---------- ------
----------- -
-
-------- ---------------
------- ------ ------------ - ------------------------
--
-
-------- --------
------- ------------------- ---- --------- ---------
--
-
-------- ---- -----------
------- --- ----------------------- --------------- ------
-
-
-当我们完成配置文件之后，只需要在命令行输入以下命令即可使用自定义样式生成 README.md：
prettyreadme --config .prettyreadmerc.json
总结
使用 prettyreadme 可以大大提高文档编写效率。我们可以选择默认样式、社区样式或自定义样式，生成适合自己项目的文档。
此外，更多的样式和相关配置信息可以参考 prettyreadme 官方文档，快速了解使用细节。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566af81e8991b448e2edd