docker-jsdoc2md

Docker image to run jsdoc2md (jsdoc-to-markdown).

Motivation

Run

$ 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:

"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 / Docker for Windows

Known Issues

... none known so far ...

Changelog

See CHANGELOG file

About

Author

Stefan Walther

• stefanwalther.io
• qliksite.io
• github/stefanwalther
• Twitter
• LinkedIn

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. 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.

MIT