grunt-koara v0.5.4

grunt-koara

Getting Started

This plugin requires Grunt.

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

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

grunt.loadNpmTasks('grunt-koara');

The "koara" task

Overview

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

grunt.initConfig({
  koara: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.extensions

Type: Array Default value: ["autolinks", "tables"]

An array of extensions that are allowed to parse.

options.template

Type: String Default value: __dirname + '/template.html'

A html template file that is used as a wrapper, so that the content generates a full html page. The plugin has a simple template build in. You can use your own template file that should contain <%=content%> as a placeholder.

Usage Examples

Full Example

grunt.initConfig({
	koara : {
		dist : {
			options : { 
				extensions: ["tables"],
				template: 'template.html'
			},
			files : { 
				'dist/index.html' : 'README.kd'
			}
		}
	}
})

grunt.registerTask('default', ['koara']);

License

Copyright (c) 2014 . Licensed under the Apache 2.0 license.