在软件开发中，文档是我们不可或缺的一部分。而对于自己制作的 npm 包来说，制作一个不错的 README 是至关重要的一步。在此介绍一个 npm 包——readme-template，可以方便地生成漂亮的 README.md 文件。

安装

在命令行中输入以下代码进行安装：

npm install readme-template

使用方法

在项目根目录下新建一个 readme.md 文件，输入以下代码：

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

-- --

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

npm install readme-template

## 使用方法

在项目根目录下新建一个 `readme.md` 文件，输入以下代码：

···

接下来在命令行中输入以下代码：

./node_modules/.bin/readme-template --input readme.md --output README.md

这样便可生成 README.md 文件。

参数说明

同时也支持 header 和 footer。

示例

假如我要制作一个形如下面的 README.md 文件：

my-awesome-package

描述 my-awesome-package 的作用

安装

npm install my-awesome-package

使用

const myAwesomePackage = require("my-awesome-package");

// 使用 myAwesomePackage

API

• myAwesomeFunction(param1, param2): 描述 myAwesomeFunction 的用途

贡献者

• Alice
• Bob

更新日志

• v1.0.0 发布

我们只需要输入以下代码：

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

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

-- --

npm install my-awesome-package

## 使用

```js
const myAwesomePackage = require("my-awesome-package");

// 使用 myAwesomePackage

API

• myAwesomeFunction(param1, param2): 描述 myAwesomeFunction 的用途

贡献者

• Alice
• Bob

更新日志

• v1.0.0 发布

然后使用以下命令生成 README.md 文件即可：

./node_modules/.bin/readme-template --input README.md --output README.md --header header.md --footer footer.md

## 总结

readme-template 是一个十分实用的 npm 包，对于不熟悉 markdown 语言的开发者来说，使用 readme-template 可以轻松制作美观的 README.md 文件。同时，也可以根据自己需求进行个性化定制。

> 来源：[JavaScript中文网](https://www.javascriptcn.com/post/6005582781e8991b448d5532) ，转载请注明来源
[https://www.javascriptcn.com/post/6005582781e8991b448d5532](https://www.javascriptcn.com/post/6005582781e8991b448d5532)