grunt-index

Compile a index.html file with doT.

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

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

grunt.loadNpmTasks('grunt-index');

The "index" task

Overview

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

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

Options

options.template

Type: String Default value: default.jst

A string value that specifies which template is used to generate the index file.

Usage Examples

Default Options

In this example an 'index.html' file is generated depending on the default template and the specified template data.

grunt.initConfig({
  index: {
    options: {},
    dist: {
      templateData: {},
      dest: 'index.html'
    },
  },
});

Custom Options

In this example an 'index.html' file is generated depending on the specified template and the specified template data.

grunt.initConfig({
  index: {
    options: {
      template: 'template.jst'
    },
    dist: {
      templateData: {},
      dest: 'index.html'
    },
  },
});

Contributing

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.