update-markdown-jsdoc

Updates a markdown document section with jsdoc documentation.

This CLI allows you to quickly generate and update quality readme JSDoc documentation.

Here is an example of the generated docs. Note that the API section is auto-generated, whereas the rest of the readme is editable like normal.

Install

npm install -g update-markdown-jsdoc

Usage

Related

• update-markdown-usage - Same as this module but for CLI programs instead of jsdoc libraries.
• documentation.js - JSDoc documentation generator which this module is based on.
• jsdoc - JSDoc documentation standard.

License

MIT © Travis Fischer

Support my OSS work by following me on twitter