grunt-groc

0.7.1 • Public • Published

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

Package Sidebar

Install

npm i grunt-groc

Weekly Downloads

257

Version

0.7.1

License

none

Last publish

Collaborators

  • jdcataldo