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 tested with JavaScript as well as generated JavaScript from CoffeeScript.

Demo

Usage

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
 * @return {Array} an array of string path
 */
function collectFiles(source, options, callback) {
  ...
}

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
 * @return {Array} an array of string path
###
collectFiles = (source, options, callback) ->
  ...

Installation

Install the module with: npm install doxx -g

CLI

$ 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
    --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

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.0.1 - (dox-foundation) Initial release
0.2.0 - (dox-foundation) Readable output
0.3.0 - (dox-foundation) Support for folder parsing
0.4.0 - (dox-foundation) Improved project navigation, major refactor of folder code
0.5.0 - Initial release of doxx

ronhanson/doxx