README
grunt-jsdoc
This plugin enables you to integrate the generation of comments based documentation into your Grunt build.
Generate your documentation
Install
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-jsdoc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-jsdoc');
Configuration
First, add the jsdoc
entry to the options of the initConfig
method of your Gruntfile.js :
grunt.initConfig({
jsdoc : {
dist : {
src: ['src/*.js', 'test/*.js'],
options: {
destination: 'doc'
}
}
}
});
The supported options are
src
: an array of pattern that matches the files to extract the documentation from. You can also include a README.dest
: (alias tooptions.destination
) set up the destination folder, the grunt wayjsdoc
: (optional) the path to the jsdoc bin (needed only for some border line cases)options
: options used by jsdocdestination
: the folder where the doc is generated- ... All jsdoc options are available (see usejsdocCli documentation).
ignoreWarnings
: (optional) do not show jsdoc warnings
Code Documentation
This plugin is a wrapper around jsdoc3. Please refer to the documentation for the documentation details.
Templates
The plugin includes only the jsdoc3 template but you can configure any other jsdoc3 template. For example you can use ink-docstrap.
npm install --save-dev ink-docstrap
And in your Gruntfile.js
:
jsdoc : {
dist : {
src: ['src/**/*.js', 'README.md'],
options: {
destination : 'doc',
template : "node_modules/ink-docstrap/template",
configure : "node_modules/ink-docstrap/template/jsdoc.conf.json"
}
}
}
Generation
To generate the documentation, you need to call the jsdoc
task :