Skip to content

mmarcon/docco

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

 ____
/\  _`\
\ \ \/\ \        ___         ___         ___         ___
 \ \ \ \ \      / __`\      /'___\      /'___\      / __`\
  \ \ \_\ \    /\ \ \ \    /\ \__/     /\ \__/     /\ \ \ \
   \ \____/    \ \____/    \ \____\    \ \____\    \ \____/
    \/___/      \/___/      \/____/     \/____/     \/___/


Docco is a quick-and-dirty, hundred-line-long, literate-programming-style
documentation generator. For more information, see:

http://jashkenas.github.com/docco/

$ docco

  Usage: docco [options] <filePattern ...>

  Options:

    -h, --help                     output usage information
    -V, --version                  output the version number
    -c, --css [file]               use a custom css file
    -o, --output [path]            use a custom output path
    -t, --template [file]          use a custom .jst template
    -h, --highlight [highlighter]  choose between "pygments" or "highlightjs"
    -p, --prettyname               prepend the "underscored path" to file names,
                                   e.g. app/src/foo.js => docs/app_src_foo.html
    -m, --makeindex                generates an index file listing the generated
                                   documentation files and linking to them.
    -i, --indexfile [index]        filename for the index, default is "index.html"
    -l, --indextitle [indextitle]  title that the index page will show in the
                                   <title> tag as well as in the <h1> tag. Default
                                   is "File index"

About

Literate Programming can be Quick and Dirty.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 59.1%
  • CSS 38.5%
  • C 0.7%
  • Ruby 0.7%
  • TeX 0.5%
  • Python 0.3%
  • JavaScript 0.2%