-
Notifications
You must be signed in to change notification settings - Fork 152
How to use with gulp
Lloyd Brookes edited this page Aug 10, 2016
·
10 revisions
1. Install jsdoc2md in your project
$ npm i jsdoc-to-markdown --save-dev
2. Add a simple task to your gulpfile.js
gulp.task('docs', function () {
const fs = require('fs')
const jsdoc2md = require('jsdoc-to-markdown')
return jsdoc2md.render({ files: 'lib/*.js' })
.then(output => fs.writeFileSync('docs/api.md', output))
})
- Home
- How jsdoc2md works
- Additional jsdoc tags supported
- Cherry picking which documentation appears in output
- Showcase ...
- Create ...
- How To ...
- How to use with npm run
- How to use with gulp
- How to create one output file per class
- How to document a AMD module
- How to document a CommonJS module (exports)
- How to document a CommonJS module (module.exports)
- How to document an ES2015 module (multiple named exports)
- How to document an ES2015 module (single default export)
- How to document Promises (using custom tags)
- How to document a ToDo list
- How to document ES2017 features
- How to document TypeScript
- The @typicalname tag
- Linking to external resources
- Param list format options
- Listing namepaths
- Troubleshooting