grunt-frontnote
StyleGuide Generator FrontNote Plugin for Grunt.
Getting Started
This plugin requires
- Grunt
~0.4.5
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:
grunt;
The "frontNote" task
Overview
In your project's Gruntfile, add a section named frontNote
to the data object passed into grunt.initConfig()
.
grunt;
Options
Options supported by frontnote
Usage Examples
frontNote: {
options: {
out: './doc',
template: './my-template',
overview: './overview.md',
includePath: 'assets/**/*'
},
dev: {
options: {
},
files: [
'/path/to/**/*.css',
'/path/to/**/*.sass',
'/path/to/**/*.less'
]
}
}