assemble-contrib-contextual

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

assemble-contrib-contextual

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

Upgrade notice! v0.2.0 or greater of this plugin depend on Assemble v0.5.0. This plugin will not work with Assemble v0.4.0!

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.

Type: String
Default: assemble.dest + /tmp

Destination of JSON context.

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.

Find a bug? Have a feature request? Please create an Issue.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and run docs in the command line to build the docs with Verb.

Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!

Jon Schlinkert

Brian Woodward

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


This file was generated by grunt-verb on May 01, 2014.