HTML output for Dox documentation generator
Pull request Compare This branch is 79 commits behind mattmcmanus:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
examples
lib
views
.gitignore
.npmignore
LICENSE-MIT
README.md
grunt.js
package.json

README.md

dox-foundation

Use dox to automatically generate beautiful html documentation.

Outputted HTML is based on templates and css from ZURB's Foundation and syntax highlighting is done by Prism.js.

Installation

Install the module with: npm install dox-foundation -g

Documentation

$ dox-foundation --help
  
  Usage: dox-foundation [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

  Examples:

    # stdin
    $ dox-foundation > myfile.html

    # operates over stdio
    $ dox-foundation < myfile.js > myfile.html

    # parse a whole folder
    $ dox-foundation --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 - Initial release
  • 0.2.0 - Readable output
  • 0.3.0 - Support for folder parsing

To Do

  • Start by having source code hidden
  • Improve rendered html

Thanks & Contributors

License

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