在我们的日常前端开发中，使用NPM来管理我们的开发包已经是司空见惯。同时，一个好的文档工具也是我们开发中必不可少的，如今，doxdox-plugin-dash已经成为许多前端开发者的首选文档生成工具。本文就是要详细介绍如何使用npm包doxdox-plugin-dash来生成文档。
前置条件
在使用doxdox-plugin-dash之前，你需要确认你已经安装好了相关工具，包括npm, doxdox,和dash。
关于在电脑上如何安装这些工具，建议可以参考官方的文档。
使用方法
步骤一：安装npm包doxdox-plugin-dash
npm i doxdox-plugin-dash --save-dev
步骤二：在项目根目录创建配置文件
在项目根目录下创建doxdox.config.js文件，并在文件中添加如下代码：
module.exports = {
"input": ["src/*.js"],
"output": "DOCSET",
"dashDocsetKeyword": "yourkeyword",
"templates": ["compact"],
"detailedOutput": false
}- "input": ["src/*.js"]，你需要根据你的实际目录情况修改此参数，这个参数指定了项目中所有需要生成文档的js文件路径。
- "output": "DOCSET"，表示输出的文档格式，这里我们选择生成为Dash格式。
- "dashDocsetKeyword": "yourkeyword"，这个参数是自定义的生成文档时的关键词，用户可以通过Dash搜索框直接快速搜索到相关文档。
- "templates": ["compact"]，选择使用的模板，这里我们选用的是doxdox自带的compact模板。
- "detailedOutput": false，这个参数表示是否生成详细的文档内容，这里我们选择false。
步骤三：生成文档
执行以下命令来生成文档：
doxdox ./doxdox.config.js
在上面的命令之后，doxdox-plugin-dash会读取doxdox.config.js的配置文件并生成相应的文档。
步骤四：导入文档
打开dash，将生成的docset文件拖放到Dash的docset管理器中，之后你就可以愉快的使用生成好的文档了。
小结
本文主要介绍了npm包doxdox-plugin-dash的使用教程，包括前置条件和使用步骤。希望这篇文档能够对你今后的开发工作产生帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a730d092702382255a