grunt-markdox
A grunt task for running markdox.
Getting Started
This plugin requires Grunt ~0.4.1
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-markdox --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "markdox" task
Overview
In your project's Gruntfile, add a section named markdox
to the data object passed into grunt.initConfig()
.
grunt
Options
Type: String
or Array
Default value: {}
options.output
Type: String
or Array
Default value: undefined
The path of the file to write the generated documentation into.
options.formatter
Type: Function
Default value: undefined
A formatting function that takes a docFile and returns it.
options.compiler
Type: Function
Default value: undefined
A function that takes a filepath and data and returns the compiled data.
options.template
Type: String
Default value: undefined
The template's filepath.
src
Type: String
or Array
Default value: undefined
A string pattern that represents a file or group of files or an array file names.
dest (shortcut to options.output)
Type: String
or Array
Default value: undefined
The path of the file to write the generated documentation into.
Usage Examples
Default Options
grunt
Custom Options
grunt