Generates markdown API documentation from jsdoc annotated source code
npm install jsdoc-to-markdown
_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.
``js`
/**
* A quite wonderful function.
* @param {object} - Privacy gown
* @param {object} - Security
* @returns {survival}
*/
function protection (cloak, dagger) {}
2\. Run a command.
`sh`
$ jsdoc2md example.js
3\. Get markdown output.
`markdownprotection(cloak, dagger) ⇒
survival
A quite wonderful function.
Kind: global function
| Param | Type | Description |
| ------ | ------------------- | ------------ |
| cloak | object | Privacy gown |
| dagger | object | 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 \