Docker image to run jsdoc2md (jsdoc-to-markdown).
$ docker run --rm -v ${PWD}:/opt/jsdoc2md stefanwalther/jsdoc2md "source-files" > "output"A very convenient approach is to just add a script to your package.json file:
"scripts": {
"api-docs": "docker run --rm -v ${PWD}:/opt/jsdoc2md stefanwalther/jsdoc2md ./src/index.js > ./docs/api-docs.md"
}This would convert all the jsdoc information from ./src/index.js and create a file ./docs/api-docs.md.
... none known so far ...
See CHANGELOG file
Stefan Walther
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. The process for contributing is outlined below:
- Create a fork of the project
- Work on whatever bug or feature you wish
- Create a pull request (PR)
I cannot guarantee that I will merge all PRs but I will evaluate them all.
Copyright © 2017, Stefan Walther.
MIT