在前端项目中，文档的编写和维护往往是一个非常繁琐的工作。这时候，使用 esdoc2 工具可以简化这个过程，并且让文档更加易于维护。本文将介绍如何使用 esdoc2-inject-script-plugin 插件来将自定义脚本注入到 esdoc2 生成的文档中。
安装
在项目目录下，使用以下命令安装 esdoc2-inject-script-plugin：
npm install esdoc2-inject-script-plugin --save-dev
配置
在项目的 .esdoc.json 中加入以下配置项：
-- -------------------- ---- -------
-
---------- -
-
------- ------------------------------
--------- -
--------- ---------------------
-
-
-
-这里定制了一个 script 配置项，它指定了我们要注入到文档中的自定义脚本路径。这个路径可以是相对路径或绝对路径。
示例
假设我们有一个自定义脚本 ./scripts/custom.js，它的内容如下：
document.addEventListener('DOMContentLoaded', function() {
console.log('Custom script is loaded!');
});当我们执行以下命令：
node_modules/.bin/esdoc -c .esdoc.json
我们会在生成的文档中看到以下内容：
-- -------------------- ---- -------
--------- -----
----- ----------
------
----- ----------------
--------- ------- ---------------------
---
-------
------
---
------- -----------------------------------
-------
-------而在浏览器中打开生成的文档，我们可以看到控制台输出了 Custom script is loaded!。
总结
通过使用 esdoc2-inject-script-plugin 插件，我们可以方便地将自定义脚本注入到 esdoc2 生成的文档中，从而实现更加灵活的文档定制。这对于我们在编写前端项目文档时是非常有用的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566b381e8991b448e2fba