Grunt module for using mox( A markdown javascript documentation generator)
npm install grunt-mox> Grunt module for using mox( A markdown javascript documentation generator)
Check out the example mox output here


~0.4.1If 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-mox --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-mox');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
mox: {
your_target: {
sourceFiles : ['sourceFile1.js','sourceFile2.js'],
options: {
name: "Grunt-Mox",
version:"0.1.0",
template : "default",
outputFile:"outputFile.md",
moxJsonFile : "moxJsonFile.json",
htmlFile : "htmlOutput.html"
}
},
},
})
`$3
#### sourceFiles
Type:
String | ArraySource file(s) or directories to get documentation from
$3
#### name
Type:
StringName of application or project generating documentation for.
#### version
Type:
StringVersion of documentation or application generating documentation for.
#### template
Type:
String
Default: defaultTemplate used to generate documentation. Can be the path to a custom template or one of the predefined mox templates. See mox documentation for more details.
#### outputFile
Type:
StringFile path to output mox markdown documentation.
#### htmlFile
Type:
StringFile path to output dox html documentation.
#### moxJsonFile
Type:
StringFile path to output dox json object. See mox documentation for more details.
$3
#### Default Template
In this example, the default mox template will be used to generate documentation for the specfied source files.
`js
grunt.initConfig({
mox: {
your_target: {
sourceFiles:['sourceFile1.js','sourceFile2.js']
options: {
outputFile: 'outputFile.md'
}
},
},
})
`#### Mox Template
In this example, the category mox template will be used to generate documentation for the specfied source files.
`js
grunt.initConfig({
mox: {
your_target: {
sourceFiles:['sourceFile1.js','sourceFile2.js']
options: {
outputFile: 'outputFile.md',
template: 'category'
}
},
},
})
`#### Custom Template
In this example, a custom jade template will be used to generate documentation for the specfied source files.
``js