在现代的 Web 开发中，文档的生成往往也成为了开发者们必不可少的一部分。而针对 Node.js 基于 Egg.js 开发的应用而言，egg-docs-keeper 可以帮助我们更加方便地实现文档生成。本文将为您介绍 egg-docs-keeper 的使用教程。
什么是 egg-docs-keeper？
egg-docs-keeper 是一个 Node.js 的模块。它使用 egg-mock 为框架提供了一个测试用例，来保障我们的文档内容的正确性和健壮性。它提供了一套基于自定义规则的文档生成方案，使得文档编写不再繁琐且可以高效统一管理。
egg-docs-keeper 的安装
你可以通过 npm 下载 egg-docs-keeper。
$ npm install egg-docs-keeper
egg-docs-keeper 的使用
使用 egg-docs-keeper 可能稍微有些繁琐，但只要跟着以下步骤去做，你肯定可以轻松上手。
步骤一：在应用中加入 egg-docs-keeper 插件
在 config/plugin.js 文件中，新增 egg-docs-keeper 的配置。
// config/plugin.js
exports.docsKeeper = {
enable: true,
package: 'egg-docs-keeper',
};步骤二：配置 egg-docs-keeper
在 config/config.default.js 文件中，添加如下配置
-- -------------------- ---- ------- -- ------------------------ ------------------ - - -- ------- ------- ------- -- ---------- ------ - ---------- -------- ------- -- -------- ---------- -------------- -- -------------- ---------- ------------- -- ------------------------- ------------ ------------------ -- ------------------------- ------------ ------------ -- ------ ------ -- --
- docDir：文档所在的目录。
- docType：文档输出的格式，支持 html 和 markdown。
- outputDir：文档输出的位置。
- indexFile：文档首页的文件名。
- includesDir：需要构建的文档的目录名称。
- excludesDir：需要排除的文档的目录名称。
- depth：目录层数的范围，用于限制生成文档目录的深度。
步骤三：在应用中写好文档
请按照以下规则编写你的文档：
- 目录及文件名仅支持英文。
- 选定文档目录，编写各自的文档文件。
- 文档目录的目录名将显示在文档导航栏中。
示例（使用 Markdown 格式）：
-- -------------------- ---- ------- - ----- --- -- -- -- ---------- -- -- ---------- --- -- ------------ ---- ---- ------------
步骤四：生成文档
执行以下命令即可生成文档：
$ npm run docs
执行完成后，你会在 outputDir 目录下看到你的文档。现在你已经完成了调用 egg-docs-keeper 生成文档的所有步骤。
总结
在本文中，我已经为您介绍了 egg-docs-keeper 的使用教程。本文中所述的示例代码也许会对您有所帮助。我们可以通过这种方式来更好地整理和管理我们的文档。只要你扎实地理解本文中的内容和示例，你就可以在你的项目中很好地使用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056be481e8991b448e5982