esdoc-integrate-manual-plugin 是一个能够将手动编写的文档集成到 ESDoc 生成的 API 文档中的插件。本文将介绍如何使用这个 npm 包。
安装
首先，我们需要用 npm 安装 esdoc-integrate-manual-plugin:
npm install --save-dev esdoc-integrate-manual-plugin
配置
在 .esdoc.json 文件的 plugins 字段中添加 esdoc-integrate-manual-plugin，如下所示：
-- -------------------- ---- -------
-
---------- -
-
------- --------------------------------
--------- -
--------- ---------------
-
-
-
-其中，"manual" 指定了手动编写的 API 文档所在的目录。在我们的示例中，这个目录是 "./docs/manual"。
编写手动文档
在指定的目录下，我们可以创建一个名为 index.md 的文件，作为手动文档的入口文件。
例如，我们的项目有一个 greet 函数，我们想要为它编写一份手动文档。我们可以在 ./docs/manual 目录下创建一个名为 index.md 的文件，并写入如下内容：
-- -------------------- ---- ------- - --- -- -- ----------- --- -- - ------- -------- -------- --- --- -------- ---------
生成文档
现在，我们可以使用 ESDoc 来生成包含手动文档的 API 文档了。
npx esdoc
执行完上面的命令后，会在 ./docs/ 目录下生成一个名为 index.html 的文件，打开它就可以看到我们编写的手动文档已经集成到了 API 文档中。
结论
通过 esdoc-integrate-manual-plugin，我们可以将手动编写的 API 文档与自动生成的 API 文档结合起来，使得整个文档更加完整和可读。同时，这个 npm 包也提醒我们，手动编写文档是非常重要且有指导意义的，能够帮助我们更好地理解和运用代码。
示例代码
请参考上面的配置和手动文档部分。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/47263