yoctore/yocto-doc - Documentation

This module is a grunt task to generate automatic documentation for a javascript project

This module is based on jsdoc for language syntax and on Braintree JSDoc Template for templating.

To use it just setup your Gruntfile.js file with this example and change needed property.

Source:

yoctodoc.js, line 11

Example

module.exports = function (grunt) {

grunt.initConfig({
 // default package
 pkg       : grunt.file.readJSON('package.json'),
 // Define yocto doc config
 yoctodoc  : {
   options : {
     destination     : './docs',
     copyExtraFiles  : [ 'assets/*.png' ]
   },
  all     : [ 'tasks/yoctodoc.js' ]
 }
});

// Register Task
grunt.registerTask('doc', [ 'yoctodoc' ]);