assemble-contrib-contextual

Generates a JSON file containing the context of each page. Basic plugin to help see what's happening in the build.

npm install assemble-contrib-contextual
6 downloads in the last day
8 downloads in the last week
52 downloads in the last month

assemble-contrib-contextual NPM version

Generates a JSON file containing the context of each page. Basic plugin to help see what's happening in the build.

Getting Started

In the command line, run:

npm install assemble-contrib-contextual --save

Next, to register the plugin with Assemble in your project's Gruntfile you can either specify the direct path to the plugin(s) (e.g. ./path/to/plugins/*.js), or if installed via npm, make sure the plugin is in the devDependencies of your project.js package.json, and simply add the module's name to the plugins option:

module.exports = function(grunt) {

  // Project configuration.
  grunt.initConfig({
    assemble: {
      options: {
        plugins: ['assemble-contrib-contextual', 'other/plugins/*.js'],
        contextual: {
          dest: 'tmp/'
        }
      },
      files: {
        'dist/': ['templates/*.hbs']
      }
    }
  });
  grunt.loadNpmTasks('assemble');
  grunt.registerTask('default', ['assemble']);
};

If everything was installed and configured correctly, after running grunt assemble you should see a JSON file for each page in the dest directory defined in the plugin's options. The basename of each page will be used as the name of each file.

This plugin will make the build run slower! To disable it simple remove it from the options or remove the dest property.

Visit the plugins docs for more info or for help getting started.

Options

dest

Type: String
Default: assemble.dest + /tmp

Destination of JSON context.

Assemble plugins

Here are some related projects you might be interested in from the Assemble core team.

Visit assemble.io/plugins for more information about Assemble plugins.

Contributing

Find a bug? Have a feature request? Please create an Issue. Pull requests are also encouraged. If you find this project useful, please consider "starring" it to show your support! Thanks!

Authors

Jon Schlinkert

Brian Woodward

License

Copyright (c) 2013 Jon Schlinkert, contributors. Released under the MIT license


This file was generated by grunt-readme on Thursday, November 28, 2013.

npm loves you