grunt-groc

Generate documentation using groc

npm install grunt-groc
470 downloads in the last day
2 401 downloads in the last week
10 561 downloads in the last month

grunt-groc

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

Groc depends on Pygments to generate documentation. Follow the installation instructions here.

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

npm loves you