Blob Blame History Raw
.TH DOCCO "1" "March 2013" "docco 0.6.1" "User Commands"
.SH NAME
docco \- The Quick and Dirty Literate Programming Documentation Generator
.SH SYNOPSIS
Usage: docco [\fIoptions\fR] <\fIfilePattern\fR> ...
.SH DESCRIPTION
Docco is a quick-and-dirty documentation generator, written in Literate CoffeeScript. It produces an HTML document that displays your comments intermingled with your code. All prose is passed through Markdown, and code is passed through Pygments syntax highlighting.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
output usage information
.TP
\fB\-V\fR, \fB\-\-version\fR
output the version number
.TP
\fB\-c\fR, \fB\-\-css\fR [file]
use a custom css file
.TP
\fB\-o\fR, \fB\-\-output\fR [path]
use a custom output path
.TP
\fB\-t\fR, \fB\-\-template\fR [file]
use a custom .jst template
.SH AUTHORS
The main author of docco is Jeremy Ashkenas <\fBjashkenas@gmail.com\fR>.
For a more complete list of contributors, see the GitHub page at
<\fBhttps://github.com/jashkenas/docco\fR>.
.SH "REPORTING BUGS"
Please report bugs on the GitHub issue tracker:
<\fBhttps://github.com/jashkenas/docco/issues\fR>.