gulp-jason-jsdoc
实时编译 jsdoc文档 的开发环境,基于 gulp-jsdoc3
安装
npm install --save-dev gulp-jason-jsdoc
使用
gulp;
options
参数名 | 类型 | 说明 |
---|---|---|
src | String, Arrary | 监听的文件路径, gulp.src |
jsDocConfig | Object | jsdoc配置 |
connectConfig | Object | gulp-conntent 配置 |
注意:
- 每次启动文档环境时,会删除一次之前的文档文件。
- 启动的服务器的根目录为 jsdoc 配置中的输出目录。
项目启动
通过 src 中的 test.js 测试
启动指令
gulp