Convert JSDoc comment blocks ...

/**
 * Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
 *
 *     parseInputs(['src/*.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
 *
 * @param {Array} inputs Array of directory globs and/or files.
 * @param {Object} config Configuration object.
 * @param {String} config.ignore Array of paths to ignore.
 * @param {String} config.parser String representing the parser to be used.
 * @param {String} config.layout String representing the layout plugin to be used.
 * @return {Object} Promise
 * @public
 */

... into easy to read documentation!

Bootstrap template plugin, included with doxdox

Getting Started

Install doxdox with NPM

$ npm install doxdox -g

Generate documentation

$ doxdox 'lib/**/*.js' --layout markdown --output DOCUMENTATION.md

Read more about the different layouts available.

Using doxdox.org

doxdox.org is a hosted, free to use, version of doxdox. It currently only supports GitHub repositories.

Add a badge to your GitHub README.md

Specify a GitHub repo path to link to dynamically generated documentation.

[![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/<username>/<repo>)

Or you can omit the repo path entirely and doxdox.org will automatically detect what repo and branch it's coming from and redirect you.

[![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/)

Plugins

doxdox-plugin-bootstrap

NPM Version Latest Documentation

Bootstrap template plugin for doxdox.

doxdox-parser-dox

NPM Version Latest Documentation

Dox parser plugin for doxdox.

doxdox-plugin-markdown

NPM Version Latest Documentation

Markdown template plugin for doxdox.

doxdox-plugin-handlebars

NPM Version Latest Documentation

Custom Handlebars template plugin for doxdox.

doxdox-plugin-dash

NPM Version Latest Documentation

Dash export plugin for doxdox.

doxdox-plugin-github-wiki

NPM Version Latest Documentation

GitHub wiki export plugin for doxdox.

doxdox-plugin-example

NPM Version Latest Documentation

Example template plugin for doxdox.

See more plugins at npmjs.com.