README
gulp-jsdoc3
Installation
Install gulp-jsdoc
as a development dependency:
npm install --save-dev gulp-jsdoc3
Usage
const jsdoc = require('gulp-jsdoc3');
gulp.task('doc', function (cb) {
gulp.src(['README.md', './src/**/*.js'], {read: false})
.pipe(jsdoc(cb));
});
By default, documentation is output to docs/gen
. gulp-jsdoc3 does not modify the source vinyl stream so the output location can only be specified via config, not gulp.dest()
. You can see all the default options passed to jsdoc in src/jsdocConfig.json
.
You can also pass in your own config to override the defaults. All CLI options can be specified here.
const jsdoc = require('gulp-jsdoc3');
gulp.task('doc', function (cb) {
const config = require('./jsdoc.json');
gulp.src(['README.md', './src/**/*.js'], {read: false})
.pipe(jsdoc(config, cb));
});
Another good example is in this project's gulpfile!
Overriding the default layout
ink-docstrap is used as the default layout but you can easily override it in your config like this:
{
"templates": {
"default": {
// Set my own layout file
"layoutFile": "./layout.tmpl"
}
}
}
Other config tips and tricks
Use include and exclude patterns to filter the globs from gulp even more. For example, only include .js,.jsdoc, or .jsx files that do not start with _:
"source": {
"includePattern": ".+\\.js(doc|x)?