grunt-contrib-yuidoc-iq v0.1.0

NOTE: Development on this fork has been discontinued and its published npm package deprecated. Newly generated Backbone Application Template web apps will, as of version 1.0.0, no longer install this dependency. Please use the stock version instead.

A custom version of grunt-contrib-yuidoc which uses the custom version of YuiDoc from Marviq. This package is available on Marviq's private NPM server.

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 ( be sure your using the Marviq private NPM ):

npm install grunt-contrib-yuidoc-iq --save-dev

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

grunt.loadNpmTasks('grunt-contrib-yuidoc-iq');

*This plugin was designed to work with Grunt 0.4.x.

Yuidoc task

Run this task with the grunt yuidoc command.

Visit the YUIDoc project home for more information on YUIDocs and commenting syntax.

Options

Settings mirror YUIDoc config.

Usage Examples

grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),
  yuidoc: {
    compile: {
      name: '<%= pkg.name %>',
      description: '<%= pkg.description %>',
      version: '<%= pkg.version %>',
      url: '<%= pkg.homepage %>',
      options: {
        paths: 'path/to/source/code/',
        themedir: 'path/to/custom/theme/',
        outdir: 'where/to/save/docs/'
      }
    }
  }
});

Release History

• 2014-04-12   v0.1.0   Initial version

---