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!
Getting Started
Install doxdox with NPM
$ npm install doxdox -g
Generate documentation
$ doxdox 'lib/**/*.js' --layout markdown --output DOCUMENTATION.md
Using doxdox.org
doxdox.org is a hosted, free to use, version of doxdox. It currently only supports GitHub repositories.
Lastest documentation generated
Add a badge to your GitHub README.md
Specify a GitHub repo path to link to dynamically generated documentation.
[](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.
[](https://doxdox.org/)
Plugins
See more plugins at npmjs.com.