Skip to content
This repository has been archived by the owner on Jul 16, 2020. It is now read-only.
/ grunt-groc Public archive

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

License

Notifications You must be signed in to change notification settings

jdcataldo/grunt-groc

Repository files navigation

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published