view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI
Upgraders, please read the release notes
Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.
1. Document your code using valid jsdoc comments.
/** * A quite wonderful function. * @param {object} - Privacy gown * @param {object} - Security * @returns {survival} */ function protection (cloak, dagger) {}
2. Run a command.
$ jsdoc2md example.js
3. Get markdown output.
## protection(cloak, dagger) ⇒ <code>survival</code> A quite wonderful function. **Kind**: global function | Param | Type | Description | | ------ | ------------------- | ------------ | | cloak | <code>object</code> | Privacy gown | | dagger | <code>object</code> | Security |
$ npm install --save-dev jsdoc-to-markdown
- API documentation
- The wiki for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.
© 2014-25 Lloyd Brookes <opensource@75lb.com>.