grunt-styledown

> Grunt plugin to generate style guides via Styledown

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:

``shell
npm install grunt-styledown --save-dev
`

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

`js
grunt.loadNpmTasks('grunt-styledown');
`

The "styledown" task

$3


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

`js
grunt.initConfig({
styledown: {
build: {
files: {
'dist/styleguide/index.html': ['src/styleguide/*.md']
},
options: {
css: 'dist/css/my-styles.css'
js: 'dist/js/my-scripts.js'
title: 'My Style Guide'
}
},
},
})
`

$3

#### css
Type: String or Array
Default: none

One or multiple CSS file paths to reference from the styleguide. tags will be included in the style guide for each path.

#### js
Type: String or Array
Default: none

One or multiple JavaScript file paths to reference from the styleguide.