https://github.com/transitive-bullshit/update-markdown-jsdoc
Updates a markdown document section with jsdoc documentation.
https://github.com/transitive-bullshit/update-markdown-jsdoc
documentation jsdoc markdown readme
Last synced: about 1 year ago
JSON representation
Updates a markdown document section with jsdoc documentation.
- Host: GitHub
- URL: https://github.com/transitive-bullshit/update-markdown-jsdoc
- Owner: transitive-bullshit
- Created: 2018-05-15T18:33:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T07:03:51.000Z (over 3 years ago)
- Last Synced: 2025-05-02T01:03:54.066Z (about 1 year ago)
- Topics: documentation, jsdoc, markdown, readme
- Language: JavaScript
- Size: 1.66 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# update-markdown-jsdoc
> Updates a markdown document section with jsdoc documentation.
[](https://www.npmjs.com/package/update-markdown-jsdoc) [](https://travis-ci.com/transitive-bullshit/update-markdown-jsdoc) [](https://standardjs.com)
This CLI allows you to quickly generate and update quality readme JSDoc documentation.
Here is an [example](https://github.com/transitive-bullshit/puppeteer-github) of the generated docs. Note that the `API` section is auto-generated, whereas the rest of the readme is editable like normal.
## Install
```bash
npm install -g update-markdown-jsdoc
```
## Usage
## Related
- [update-markdown-usage](https://github.com/transitive-bullshit/update-markdown-usage) - Same as this module but for CLI programs instead of jsdoc libraries.
- [documentation.js](https://github.com/documentationjs/documentation) - JSDoc documentation generator which this module is based on.
- [jsdoc](http://usejsdoc.org/) - JSDoc documentation standard.
## License
MIT © [Travis Fischer](https://transitivebullsh.it)
Support my OSS work by following me on twitter 