导言
在前端开发中，我们经常需要为开源项目编写文档和文档更新，特别是从之前的版本进行跟踪和对新功能进行编写。而在维护的过程中，开发者往往需要在不同的地方进行文档的同步更新，如 GitHub 的 Readme 文件和发布日志。这个过程很繁琐并容易出错。但是，通过使用 npm 包 grunt-release-notes-to-readme 可以帮助我们自动生成 README.md 文档以及从 CHANGELOG.md 中自动提取内容来达到文档的同步更新。
安装
在开始使用 grunt-release-notes-to-readme 之前，我们需先安装它。你可以通过以下命令进行安装：
npm install grunt-release-notes-to-readme --save-dev
配置
完成安装后，下一步是在 Gruntfile.js 中设置 grunt-release-notes-to-readme 的任务：
-- -------------------- ---- -------
------------------
------------------------ -
-------- -
---------- ---------------
----- ------------
-------- ---- ----------- ----
--
-------- ---
--
---options.changelog：CHANGELOG 文件的路径。
options.dest：生成 README 文件的路径。
options.version：当前版本号。
使用
一旦配置完成，我们就可以开始使用 grunt-release-notes-to-readme 来自动生成 README.md 文件了。
grunt release_notes_to_readme
然后，grunt 将会自动从 CHANGELOG.md 文件中提取 changelog，添加到 README 文件中，形成一个新的 README 文件。
需要注意的是，如果你的项目使用了一个版本号的先前版本，grunt-release-notes-to-readme 会从之前的版本开始转换CHANGELOG.md 中的 change log。所以请确保项目的版本为符合你的预期。
示例
-- -------------------- ---- -------
-------------- - -------- ------- -
------------------
---- ------------------------------------
------------------------ -
-------- -
---------- ---------------
----- ------------
-------- ---- ----------- ----
--
-------- ---
--
---
----------------------------------------------------
----------------------------- -----------------------------
--以上就是使用 npm 包 grunt-release-notes-to-readme 的一些简单介绍和使用方式。通过使用它，我们可以快速自动生成 README.md 文件，从而减少重复工作并更好地维护我们的开源项目。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005609c81e8991b448ded7a