npm 包 easy-readme 使用教程-JavaScript中文网-JavaScript教程资源分享门户

npm 包 easy-readme 使用教程

在前端开发中，编写清晰明了的 README 文件是很重要的。然而，有时候我们可能会感到棘手和烦躁，因为它们被视为是毫无意义的文本和枯燥的工作。好消息是，现在有一个便捷的 npm 包 easy-readme 可以帮助我们解决这个问题。在本篇文章中，我们将了解这个包的使用教程。

安装 easy-readme

如在你前端项目目录运行以下命令将安装 easy-readme：

--- ------- -- -----------

这个包提供了一组可视化的工具，可以自动完成 README 文件的编写工作。

使用教程

1. 初始化 README 文件

在目标项目的根文件夹下创建一个 README.md 文件，然后运行下面的命令来初始化你的 README 文件：

------ ----

这将自动创建一个初始的 README 文件，它会根据你的项目类型提供一个简单的模板。接下来，我们可以使用 readme 来生成更好的 README 文件。下图是初始化后自动生成的 README 文件：

2. 编写 README 文件

原始的 readme 文件只是一个模板，你需要逐步完善它来表示你的项目，因此我们需要添加详细的描述、标签和协议等内容，以突出您的项目。

3. 生成 README 文件

完成 README 的编写我们需要运行下面的命令来生成整合完善的 README 文件：

------ -----

这将根据你编写的信息，自动生成你所需要的 README 文件。看下面生成的 README 文件：

- -------

- ---------

------ --------------------------------------------------------------------------------------------------------

--------

-- --

- ---------
- ---------
- ---- ------------
- ---------
- -------------

-- --

--- ---

----
-----
--- ------- ------ -----------

手动下载安装

点击下载链接来下载最新版的包。

引入

----- ---------- - -----------------------

用法

-----------------------------------

API 文档

options: object
- title: string 如果不传则自动填写当前目录
- description：string 如果不传则自动填写 README 中的 description 部分
- gitUrl：string git 仓库链接
- note: string 如果不传则自动填写 README 中的 note 部分
- badgeList：Array(object) 徽章列表

选项

`options.title`

项目标题

在 options 中输入标题，使用说明：

-
  -------- ----
-

`options.description`

项目描述

-
  -------------- ----------
-

`options.gitUrl`

git 仓库链接

-
  --------- -----------------------------------------
-

`options.note`

注意事项

-
  ------- ------
-

`options.badgeList`

徽章列表

-
  ------------ -
    -
      --------- ----------------------------------------------------------
      ---------- -------------------------------------------
    -
  -
-

测试

--- ----

授权协议

基于 MIT 协议发布，欢迎使用，如有疑问提交 issue。

-- --

------------------ --- ------ --------------- ---------- ---------------------------- ------ ------- --------------------------------------------- ----------- -----

-- ----

{ "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)" } ] }

------------------------------------------------------------------------------ ----------
-----------------------------------------------------------------------------------------------------------------------------