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 -g jsdoc-to-markdown
- API documentation
- The wiki for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.
© 2014-16 Lloyd Brookes [email protected].