https://github.com/stefanwalther/docker-jsdoc2md
Docker image to run jsdoc2md (jsdoc-to-markdown).
https://github.com/stefanwalther/docker-jsdoc2md
api-documentation docker-image docker-jsdoc2md documentation jsdoc-to-markdown jsdoc2md markdown
Last synced: about 1 month ago
JSON representation
Docker image to run jsdoc2md (jsdoc-to-markdown).
- Host: GitHub
- URL: https://github.com/stefanwalther/docker-jsdoc2md
- Owner: stefanwalther
- Created: 2017-09-23T17:11:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T11:36:53.000Z (about 1 year ago)
- Last Synced: 2025-04-12T20:12:00.420Z (about 1 year ago)
- Topics: api-documentation, docker-image, docker-jsdoc2md, documentation, jsdoc-to-markdown, jsdoc2md, markdown
- Language: Shell
- Homepage:
- Size: 83 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# docker-jsdoc2md
> Docker image to run jsdoc2md (jsdoc-to-markdown).
[](https://circleci.com/gh/stefanwalther/docker-jsdoc2md/tree/master)
## Motivation
## Run
```sh
$ docker run --rm -v ${PWD}:/opt/jsdoc2md stefanwalther/jsdoc2md "source-files" > "output"
```
### Run as npm script
A very convenient approach is to just add a script to your `package.json` file:
```js
"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`.
## Configuration
## Installation
### Prerequisites
- [Docker for Mac](https://docs.docker.com/docker-for-mac/) / [Docker for Windows](https://docs.docker.com/docker-for-windows/)
## Known Issues
... none known so far ...
## Changelog
See [CHANGELOG file](CHANGELOG.yml)
## About
### Author
**Stefan Walther**
* [stefanwalther.io](http://stefanwalther.io)
* [qliksite.io](http://qliksite.io)
* [github/stefanwalther](https://github.com/stefanwalther)
* [Twitter](http://twitter.com/waltherstefan)
* [LinkedIn](https://www.linkedin.com/in/stefanwalther/)
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/stefanwalther/docker-jsdoc2md/issues). The process for contributing is outlined below:
1. Create a fork of the project
2. Work on whatever bug or feature you wish
3. Create a pull request (PR)
I cannot guarantee that I will merge all PRs but I will evaluate them all.
### License
Copyright © 2017, [Stefan Walther](http://qliksite.io).
MIT