Skip to content

Commit

Permalink
Clarifying default options and how they're set (#35)
Browse files Browse the repository at this point in the history
This addresses some confusion from users migrating from the old gulp-jsdoc plugin and how the destination folder is set.

Examples:
#23, #27, #24
  • Loading branch information
AndrewGuenther authored and mlucool committed Sep 23, 2016
1 parent 6aa3c89 commit 7623191
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ gulp.task('doc', function (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`](https://github.com/AndrewGuenther/gulp-jsdoc3/blob/master/src/jsdocConfig.json).

You can also pass in your own config to override the defaults. All CLI options can be specified here.

```javascript
Expand Down

0 comments on commit 7623191

Please sign in to comment.