grunt-doxv v0.2.0

grunt-doxv

This plugin enables you to integrate Doxv into your Grunt build.

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-doxv --save-dev

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

grunt.loadNpmTasks('grunt-doxv');

Configuration

Configure the plugin to your project's Gruntfile.js

First, add the doxv entry to the options of the initConfig method :

grunt.initConfig({
    doxv : {
      options: {
        title: "Doxv documentation"
      },
      files: {
        src: ['src'],
        dest: ['doc']
      } 
    }
});

The supported options are

• exclude: exclude the directories to be parsed

Then, load the plugin

grunt.loadNpmTasks('grunt-doxv');

Release History

• 0.1.0 First release

License

Copyright (c) 2014 Jiale Hu
Licensed under the MIT license.