JS Doc Generator

Generate documentation for your JS files using JsDoc, and using docDash template.

See sample usage at: https://github.com/mitzerh/sample-jsdoc-generator

npm install --save jsdoc-generator

Setup

1. Instantiate

const Generator = require('jsdoc-generator');

const config = {
	silent: true,
	dest: '/path/to/output/folder',
    paths: [{
		name: 'my-app',
		source: '/path/of/your-app'
	},
	{
		name: 'another-app',
		source: '/path/of/your-other-app'
	}]
};

mydocs = new Generator(config);
mydocs.generate();

Configuration properties:

| Property | Type | Description | |:---------|:-----|:------------| | dest | String | Destination output directory | | silent | Boolean | Output or suppress logs (default: false) | | paths | Array | List of source paths where you want jsdoc to run | | paths[].name | String | The custom folder name of your documentation | | paths[].source | String | The source path of the documentation |