grunt-docdown
Generate documentation from markdown files
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:
npm install grunt-docdown --save
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "docdown" task
Overview
In your project's Gruntfile, add a section named docdown
to the data object passed into grunt.initConfig()
. Use the files
object to point to your documentation folder. You can see a sample folder at test/fixtures/content
.
grunt;
Options
options.assets
Type: String
Required: Yes
The folder that holds you asset files. You can use the files in test/fixtures/assets
as a base and build your own theme.
Release History
(Nothing yet)