README.md

grunt-contrib-yuidoc

Compile YUIDoc Documentation (part of the grunt-contrib collection). Submitted by George Pantazis.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-contrib-yuidoc

Then add this line to your project's grunt.js gruntfile:

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

Overview

Inside your grunt.js file add a section named yuidoc. Visit the YUIDoc project home for more information on YUIDocs and commenting syntax.

Parameters

options object

This controls how this task operates and should contain key:value pairs, see options below.

Options

Options correlate to YUIDoc config objects.

paths (required) string|array

What directory should be scanned to generate doc data.

outdir (required) string

Where to save the documentation.

Config Example

yuidoc: {
  compile: {
    "name": "Project Name",
    "description": "Project Description",
    "version": "1.0.2",
    "url": "http://projecturl.com/",
    options: {
      paths: "path/to/source/code/",
      outdir: "where/to/save/docs/"
    }
  }
}

Release History

• 2012/08/23 - v0.3.0 - Options no longer accepted from global config key.
• 2012/08/10 - v0.2.0 - Refactored from grunt-contrib into individual repo.