- Notifications
You must be signed in to change notification settings - Fork152
Generate markdown documentation from jsdoc-annotated javascript
License
NotificationsYou must be signed in to change notification settings
jsdoc2md/jsdoc-to-markdown
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Upgraders, please read therelease notes
Generates markdown API documentation fromjsdoc 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} */functionprotection(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
- Thewiki for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.
© 2014-25 Lloyd Brookes <opensource@75lb.com>.
About
Generate markdown documentation from jsdoc-annotated javascript
Topics
Resources
License
Code of conduct
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
No packages published