在前端开发中，编写清晰明了的 README 文件是很重要的。然而，有时候我们可能会感到棘手和烦躁，因为它们被视为是毫无意义的文本和枯燥的工作。好消息是，现在有一个便捷的 npm 包 easy-readme 可以帮助我们解决这个问题。在本篇文章中，我们将了解这个包的使用教程。
安装 easy-readme
如在你前端项目目录运行以下命令将安装 easy-readme：
npm install -g easy-readme
这个包提供了一组可视化的工具，可以自动完成 README 文件的编写工作。
使用教程
1. 初始化 README 文件
在目标项目的根文件夹下创建一个 README.md 文件，然后运行下面的命令来初始化你的 README 文件：
readme init
这将自动创建一个初始的 README 文件，它会根据你的项目类型提供一个简单的模板。接下来，我们可以使用 readme 来生成更好的 README 文件。下图是初始化后自动生成的 README 文件：
2. 编写 README 文件
原始的 readme 文件只是一个模板，你需要逐步完善它来表示你的项目，因此我们需要添加详细的描述、标签和协议等内容，以突出您的项目。
3. 生成 README 文件
完成 README 的编写我们需要运行下面的命令来生成整合完善的 README 文件：
readme build
这将根据你编写的信息，自动生成你所需要的 README 文件。看下面生成的 README 文件：
-- -------------------- ---- ------- - ------- - --------- ------ -------------------------------------------------------------------------------------------------------- -------- -- -- - --------- - --------- - ---- ------------ - --------- - ------------- -- -- --- --- ---- ----- --- ------- ------ -----------
手动下载安装
点击下载链接来下载最新版的包。
引入
const easyReadme = require("easy-readme");用法
easyReadme.generateReadme(options);
API 文档
options: objecttitle: string如果不传则自动填写当前目录description：string如果不传则自动填写 README 中的 description 部分gitUrl：stringgit 仓库链接note: string如果不传则自动填写 README 中的 note 部分badgeList：Array(object)徽章列表
选项
options.title
项目标题
在 options 中输入标题，使用说明：
{
"title": "标题"
}options.description
项目描述
{
"description": "这是一个项目描述"
}options.gitUrl
git 仓库链接
{
"gitUrl": "https://github.com/coachbaggie/fifi.git"
}options.note
注意事项
{
"note": "注意事项"
}options.badgeList
徽章列表
{
"badgeList": [
{
"imgUrl": "https://img.shields.io/npm/v/easy-readme.svg?style=flat",
"linkUrl": "https://www.npmjs.com/package/easy-readme"
}
]
}测试
npm test
授权协议
基于 MIT 协议 发布，欢迎使用，如有疑问提交 issue。
## 总结 我们可以看到，easy-readme 使编写 README 文件变得简单易行。无论是我们的 JavaScript 类库还是网站应用，在发布之前，我们应该考虑编写一个良好的 README 文件。通过使用 easy-readme，我们可以减少不必要的时间和烦恼。希望这篇文章能够帮助你学习如何使用 easy-readme 这个工具。 ## 示例代码
{ "title": "你的应用名称", "description": "这是一句简单的描述。", "gitUrl": "http://your.git.repo.url", "note": "这是一条额外的注意事项", "badgeList": { "imgUrl": "https://img.shields.io/travis/oclif/oclif.svg?style=flat&logo=travis", "linkUrl": "(https://travis-ci.org/oclif/oclif)" }, { "imgUrl": "https://img.shields.io/codecov/c/github/oclif/oclif.svg?style=flat", "linkUrl": "(https://codecov.io/gh/oclif/oclif)" }, { "imgUrl": "https://npmjs.com/package/oclif", "linkUrl": "(https://npmjs.com/package/oclif)" }, { "imgUrl": "https://npmjs.com/package/oclif", "linkUrl": "(https://npmjs.com/package/oclif)" } ] }
> 来源：[JavaScript中文网](https://www.javascriptcn.com/post/6005727081e8991b448e8a71) ，转载请注明来源 [https://www.javascriptcn.com/post/6005727081e8991b448e8a71](https://www.javascriptcn.com/post/6005727081e8991b448e8a71)