grunt-manual

Print grunt task infomation.

Getting Started

This plugin requires Grunt ~0.4.0

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-manual --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-manual');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Manual task

Run this task with the grunt manual command.

Options

printAllTasks

Type: Boolean
Default: true

if this options sets to false, tasks will be printed when task's options.includeToManual is true.

includeToManual

Type: Boolean

Note that this option can be added to any task.

manualText

Type: String

Note that this option can be added to any task and it's target option.

Usage Examples

Refer to Gruntfile.js