npm 是 Node.js 的包管理器，是前端工程师工作中经常使用的工具。在开发中，经常会使用一些第三方包，这些包通常都带有自己的文档和说明，但有时我们需要一个更简洁、直接的方式来查看包的使用方法和API。
@kgryte/readme 就是一个能够生成自解释文档的 npm 包，它能够将一个项目的README文件转换成交互式的HTML文件，使得用户可以更方便地了解该项目的使用方法和功能。
本篇文章将介绍如何使用 @kgryte/readme 来生成交互式的文档，并带有详细的代码示例和深度的解释。
安装
首先要确保你已经安装了最新版本的 Node.js 和 npm 包管理器。在命令行中输入下面命令来安装@kgryte/readme:
npm install -g @kgryte/readme
@kgryte/readme 可以通过命令行或者在项目的配置文件中使用。
在命令行中使用
可以通过以下命令来使用 @kgryte/readme：
readme <path-to-readme>
其中，“path-to-readme”代表相对或绝对路径指向 README 包含的目录或文件。比如：
readme ./ readme ./README.md readme ./path/to/README.md
在项目配置文件中使用
你也可以将 @kgryte/readme 安装到项目中，并添加一些配置选项。
首先，在项目目录下使用以下命令来添加 @kgryte/readme：
npm install --save-dev @kgryte/readme
然后，在项目的 package.json 文件中添加以下配置：
{
"scripts": {
"docs": "node ./node_modules/.bin/readme ./"
}
}这里我们将 “node_modules/.bin/readme” 添加到 scripts 文件中作为一个脚本，在命令行中的时候，我们就可以使用：
npm run docs
运行完毕后，会生成一个名为“index.html”的文件。可以打开浏览器并导航到它查看文档。
代码示例
以下代码示例将展示以一个简单的字符串为例，如何使用@kgryte/readme 来生成自解释的文档。
-- -------------------- ---- ------- -- -------- -------------- - ----- ------ - -------------------------- -- --------------- ----- --------- - ------- -------- -- ------------------------- ----- ---- - ------- - ----- -- ------- ------- --- ------------- --------------- -- ------------ ----- ------- --------------- -- ----- --- --------- ---------------- ----- ----- - ------------------------- ----------------------------------------- ------ --- ----------- ---------------- ----- ----- - ------------------------- ------------------------------------------- ------ -- -- ---------- ------------------
输出结果：
-- -------------------- ---- ------- - ----- -- ------- ------- --- ------------- --------------- -- ------------ ---- ------- -------------- -- ----- --- ------- ------------- ----- ----- - ------------------------- ------------------------------- ----------
goodbye
const greet = require('@kgryte/greet');
console.log(greet.goodbye("Hello, World!"));-- -------------------- ---- ------- ---------------------------------- -- -- -- -------------- ------------------------------------------------------------------------------------------- - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------