grunt-api-meta

Generates pretty documentation pages

Getting Started

This plugin requires Grunt >=0.4.5

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-api-meta --save-dev

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

grunt.loadNpmTasks('grunt-api-meta');

The "api-meta" task

Overview

In your project's Gruntfile, add a section named api-meta to the data object passed into grunt.initConfig().

grunt.initConfig({
  "api_meta": {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

See api-meta