Skip to content
Grunt Plugin for generating Dox
JavaScript
Find file
Pull request Compare This branch is 1 commit ahead, 39 commits behind punkave:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
tasks
test
.gitignore
.npmignore
LICENSE-MIT
README.md
grunt.js
package.json

README.md

grunt-dox

Dox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using dox-foundaiton

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-dox

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-dox');

Documentation

Inside of your grunt file, add:

dox: {
  files: {
    src: ['dir/*', '*.js'],
    dest: 'docs'
  }
},

This will run all of your files through dox and dox-foundation and created a file docs/api.html

Note: This will completely deleter and recreate the docs folder

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

  • 0.1.0: Initial release
  • 0.2.0: Pass multiple files at once. Use dox-foundation for html output

License

Copyright (c) 2012 P'unk Ave Licensed under the MIT license.

Something went wrong with that request. Please try again.