grunt-docco-xt v0.1.0

Generate documentation with docco-xt.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-docco-xt --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-docco-xt');

Documentation

Run this task with the grunt doccoXT command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

basedir

Type: String Default: null

Relative paths for documented files will be based on this directory.

layout

Type: String Default: 'parallel'

Layout used ('parallel' or 'linear')

output

Type: String Default: 'docs'

Output directory.

Usage Example

doccoXT: {
    options: {
        basedir: 'src'
    },
    coffee: {
        options: {
            output: 'docs/coffee'
        },
        files: {
            src: [ 'src/coffee/**/*.coffee' ]
        }
    },
    js: {
        options: {
            output: 'docs/js'
        },
        files: {
            src: [ 'src/js/**/*.js' ]
        }
    }
}

Release History

• 2014-01-03   v0.1.0   Initial release.
• 2014-01-06   v0.1.1   Use v0.1.1 of docco-xt.