rw-grunt-formidable v0.3.3

grunt-formidable

The official Grunt plugin for the formidable static site generator

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 rw-grunt-formidable --save-dev

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

grunt.loadNpmTasks('rw-grunt-formidable');

Formidable task

You can run this task with the grunt formidable command.

Options

root

Type: String Default: 'src'

The path to the source files, with respect to the Gruntfile, that will be used by formidable to build your site.

build

Type: String Default: 'build'

The path to the build directory, with respect to the Gruntfile, where formidable will output your generated site. It may not be a parent or a child of the root directory.

templates

Type: String or Array of Strings Default: '**/templates'

The glob pattern, with respect to the root directory, which formidable will use to locate template files.

Example

Here's an example Gruntfile to help you get started:

'use strict';

module.exports = function(grunt) {

    grunt.initConfig({
        formidable: {
            all: {
                options: {
                    root: 'src',
                    build: 'dist',
                    templates: '{articles,news,pages}/templates'
                }
            }
        }
    });

    grunt.loadNpmTasks('grunt-formidable');

    grunt.registerTask('build', ['formidable:all']);
};

More options are available, so please review the source code for details.