README.md

grunt-hercule

Grunt task that wraps Hercule for simple document transclusion, ideal for Markdown documents.

Getting Started

This plugin requires Grunt ~0.4.2

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

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

grunt.loadNpmTasks('grunt-hercule');

hercule task

Run this task with the grunt hercule command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Typically you'll just want to provide files in the standard Grunt way.

hercule: {
	docs: {
		src: 'path/to/your/blueprint.md',
		dest: 'path/to/dest.md'
	}
}

Running Tests

To execute all the tests, just run:

npm test

You can also just run the available grunt commands. The default being to check the code styling of the project itself.

grunt

Contact

You can follow me on twitter at @Chesley