grunt-doxy
v0.2.0
Published
It'll generate dox for your project and wash yer dishes too!
Downloads
9
Readme
grunt-doxy
It'll generate dox for your project and wash yer dishes too!
grunt-doxy is a grunt plugin for generating markdown documentation for your project using dox and doxme.
This plugin is written with ES6 using babel.
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 dox --save-dev
npm install grunt-doxy --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-doxy');
The "doxy" task
In your project's Gruntfile, add a section named doxy
to the data object
passed into grunt.initConfig()
.
grunt.initConfig({
doxy: {
options: {
doxme: {
// These options go to doxme.
}
},
target: {
files: [{
expand: true,
cwd: 'lib/',
src: ['**/.js']
}]
},
},
});