doxx

Generic, template based, HTML output for Dox documentation generator

Doxx

Use dox to automatically generate beautiful html documentation. Doxx is a total refactoring of dox-foundation.

Outputted HTML is by default based on templates and css from Twitter Bootstrap and syntax highlighting is done by Prism.js.

Doxx was written in ES6, tranformed to ES5 with babel and tested with mocha.

JavaScript JavaDoc style

/**
 * Create an array of all the right files in the source dir
 * @param      {String}   source path
 * @param      {Object}   options
 * @param      {Function} callback
 * @jsFiddle   A jsFiddle embed URL
 * @return     {Array} an array of string path
 */
function collectFiles(sourceoptionscallback) {
  ...
}
 

CoffeeScript JavaDoc style

###*
 * Create an array of all the right files in the source dir
 * @param      {String}   source path
 * @param      {Object}   options
 * @param      {Function} callback
 * @jsFiddle   A jsFiddle embed URL
 * @return     {Array} an array of string path
###
collectFiles = (source, options, callback) ->
  ...
 

Install the module with: npm install doxx -g

$ doxx --help
 
  Usage: doxx [options]
 
  Options:
 
    -h, --help                                 output usage information
    -V, --version                              output the version number
    -r, --raw                                  output "raw" comments, leaving the markdown intact
    -d, --debug                                output parsed comments for debugging
    -t, --title <string>                       The title for the page produced
    -s, --source <source>                      The folder which should get parsed
    -i, --ignore <directories>                 Comma seperated list of directories to ignore. Default: test,public,static,views,templates
    -T, --target <target>                      The folder which will contain the results. Default: <process.cwd()>/docs
    -e, --extension <extension>  Target files extension. Default: html
    -j, --template <jade template>                 The jade template file to use
 
  Examples:
 
    # parse a whole folder
    $ doxx --source lib --target docs
 
    # parse a whole folder and use a specific template
    $ doxx --template ./view/myowntpl.jade --source lib --target docs
  • grunt-doxx - Doxx grunt plugin automatically generates the documentation for your project.
  • gulp-doxx - Doxx documentation generator for gulp

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 gulp and mocha.

Changelog

Copyright (c) 2013 Francois-Guillaume Ribreau MIT License