简介
npm 是一个 JavaScript 包管理器，用于下载、安装和管理 node.js 的包，而 readme-includes 就是一个 npm 包，它可以将 markdown 格式的文档转换成html格式，并生成用于展示的 readme.md 文件，方便展示项目文档。本篇文章将详细介绍 npm 包 readme-includes 的使用方法，帮助前端工程师更好地管理项目文档。
安装
在终端中通过以下命令进行安装：
npm install readme-includes -g
使用方法
1. 创建项目
首先创建一个名为 myProject 的项目，打开终端，输入以下指令：
mkdir myProject cd myProject npm init -y
2. 安装 readme-includes
npm install --save readme-includes
3. 修改 package.json 文件
在 "scripts" 部分添加以下代码
"scripts": {
"build:readme": "readme-includes"
},4. 创建 README.md
在项目根目录下创建一个 README.md 文件，并在其中添加如下内容：
<h1>My Project</h1> ## 安装 ...
5. 创建 includes 目录
在项目根目录下创建一个 includes 目录，用来存放待包含的文件，比如 LICENSE 文件和 CONTRIBUTING.md 文件。
6. 更改 README.md 文件
在 README.md 文件中使用 markdown 语法的 include 功能引用 includes 中的文件，例如：
## License 请查看 [LICENSE](includes/LICENSE) 文件。
7. 生成 readme 文件
在终端中输入以下指令，自动生成 readme.md
npm run build:readme
示例代码
以下为示例代码：
project |--includes |--LICENSE |--CONTRIBUTING.md |--README.md |--package.json
修改 package.json
"scripts": {
"build:readme": "readme-includes"
},修改 README.md
-- -------------------- ---- ------- ------ ------------ -- -- --- -- ------- --- --------------------------- --- -- ---- --- ------------------------------------------- ---
执行命令
在终端上执行以下命令来生成 readme.md 文件。
npm run build:readme
执行完成后，将会在项目根目录下生成 readme.md 文件，并且将 includes 目录中的文件包含在其中，方便展示项目文档。
总结
在日常的前端开发中，npm 的使用是非常必要的，而 readme-includes 工具则是帮助我们更好展示我们的项目文档，提高开发效率的好工具。通过上述文章的讲解，相信大家对 readme-includes 工具的使用已经有了更深入的了解，也更能够高效地使用 npm 包管理器来管理项目文档了。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc984b5cbfe1ea0612379