A simple grunt task to generate a project's documentation using Groc
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
.gitignore
.jshintrc
.npmignore
.travis.yml
Gruntfile.js
MIT-LICENSE.txt
README.md
package.json

README.md

grunt-groc

A simple grunt task to generate a project's documentation using Groc

Build Status Downloads

Usage

Install this plugin with the following command:

npm install grunt-groc --save-dev

Load the plugin in your Gruntfile.js:

grunt.loadNpmTasks('grunt-groc');

Running grunt groc:javascript (or grunt groc since groc is a multitask) will generate documentation for the specified files.

// Project configuration.
grunt.initConfig({
  groc: {
    javascript: [
      "tasks/*.js", "README.md"
    ],
    options: {
      "out": "doc/"
    }
  }
});

See Groc's cli for all available options