grunt-wintersmith-compile

grunt-wintersmith-compile

A grunt task for "wintersmith build" command.

Getting Started

This plugin requires Grunt ~0.4.1

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-wintersmith-compile --save-dev

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

grunt.loadNpmTasks('grunt-wintersmith-compile');

The "wintersmith_compile" task

Overview

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

grunt.initConfig({
  wintersmith_compile: {
    your_target: {
      options {
        config: 'path/to/config.json',
        output: 'path/to/build'
      }
    }
  },
})

Options

config

Type: String Default value: 'config.json'

A string value that is a path to config.json. By default, this task tries to find config.json from the same directory as Gruntfile.

output

Type: String Default value: 'build'

A string value that is a path to output directory.

Usage Examples

Default Options

grunt.initConfig({
  wintersmith_compile: {
    your_target: {}
  },
})

Custom Options

grunt.initConfig({
  wintersmith_compile: {
    your_target: {
      options: {
        config: 'path/to/config.json',
        output: 'path/to/build'
      }
    }
  }
})

Release History

(Nothing yet)