grunt-doxdox

Generate documentation with doxdox.

Installation

$ npm install grunt grunt-doxdox --save-dev

Usage

Basic Options

module.exports = function (grunt) {
 
    grunt.loadNpmTasks('grunt-doxdox');
 
    grunt.initConfig({
        'doxdox': {
            'markdown': {
                'inputs': ['facade.js'],
                'output': 'docs.md'
            }
        }
    });
 
    grunt.registerTask('default', ['doxdox']);
 
}

Custom Configuration Options

module.exports = function (grunt) {
 
    grunt.loadNpmTasks('grunt-doxdox');
 
    grunt.initConfig({
        'doxdox': {
            'html': {
                'inputs': ['script.js'],
                'output': 'docs/index.html',
                'config': {
                    'title': 'Sample Title',
                    'description': 'Lorem ipsum dolor sit amet, consectetur adipisicing elit',
                    'layout': 'docs/template.hbs',
                    'package': 'package.json'
                }
            }
        }
    });
 
    grunt.registerTask('default', ['doxdox']);
 
}