https://github.com/mattmcmanus/dox-foundation

HTML output for Dox documentation generator
https://github.com/mattmcmanus/dox-foundation

Last synced: 8 days ago
JSON representation

HTML output for Dox documentation generator

• Host: GitHub
• URL: https://github.com/mattmcmanus/dox-foundation
• Owner: mattmcmanus
• License: mit
• Created: 2012-09-23T19:14:00.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2017-02-07T03:48:47.000Z (over 7 years ago)
• Last Synced: 2024-10-14T21:31:08.582Z (22 days ago)
• Language: JavaScript
• Homepage: http://mattmcman.us/2013/01/document-all-the-things-introducing-dox-foundation/
• Size: 2.31 MB
• Stars: 83
• Watchers: 10
• Forks: 29
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# dox-foundation

[![Dependency Status](https://gemnasium.com/punkave/dox-foundation.png)](https://gemnasium.com/punkave/dox-foundation)

Use [dox](https://github.com/visionmedia/dox) to automatically generate beautiful html documentation.

Outputted HTML is based on templates and css from [ZURB's Foundation](http://foundation.zurb.com/) and syntax highlighting is done by [Prism.js](http://prismjs.com/).

## Example time!

See  ([source](https://github.com/tlvince/dox-foundation-demo)) for an interactive demo, ran against Express.

![A little sneak](http://i.cloudup.com/q9XWQ9B7qk.png)

## 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         The title of the library or program you are generating code for (eg: Express). Overrides default of "Documentation"

    -s, --source        The folder(s) which should be parsed. Multiple folders should be comma separated

    -i, --ignore   Comma seperated list of directories to ignore. Overrides default of test, public, static, views, templates

    -T, --target        The folder which will contain the results. Default: /docs

    --template   The jade template file to use

  Examples:

    # stdin

    $ dox-foundation > myfile.html

    # operates over stdio

    $ dox-foundation --title "myFile documentation" < myfile.js > myfile.html

    # parse a whole folder

    $ dox-foundation --source lib --target docs

```

## [Release History](https://github.com/punkave/dox-foundation/releases)

## Thanks & Contributors

* Thanks to [dox-basic](https://github.com/jepso/dox-basic) for the inspiration and much of the original code.

* [@sdepold](https://github.com/sdepold)

* [@fgribreau](https://twitter.com/fgribreau)

* [@phun-ky](https://github.com/phun-kyu)

## License

Copyright (c) 2012 P'unk Avenue

Licensed under the MIT license.