A simple grunt task to generate a project's documentation with Grock.
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-grock --save-dev
In your project's Gruntfile, add a section named
grock to the data object passed into
Just adapt the following configuration to generate the structured documentation of your files.
Take a look at the
grock repository to see the list of available options.
Please note that
git-remote options are not currently available in this grunt plugin.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.