betterdocco
The (not so) quick and dirty literate programming documentation generator.
Last updated 2 years ago by igoramadas .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install betterdocco 
SYNC missed versions from official npm registry.

Better Docco

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

https://github.com/igoramadas/betterdocco

What's different compared to the original Docco?

Better Docco will use the full path of source files on the menu and filenames. So you can have for instance a index.coffee under /mymodule and another index.coffee under /anothermodule and have both documented at the same batch.

Installation:

$ sudo npm install -g betterdocco

Usage

$ betterdocco [options] FILES

Options:

-h, --help             output usage information
-V, --version          output the version number
-l, --layout [layout]  choose a built-in layouts (parallel, linear)
-c, --css [file]       use a custom css file
-o, --output [path]    use a custom output path
-t, --template [file]  use a custom .jst template
-e, --extension [ext]  use the given file extension for all inputs
-L, --languages [file] use a custom languages.json
-m, --marked [file]    use custom marked options

Current Tags

  • 0.8.0                                ...           latest (2 years ago)

8 Versions

  • 0.8.0                                ...           2 years ago
  • 0.7.7                                ...           2 years ago
  • 0.7.6                                ...           3 years ago
  • 0.7.5                                ...           3 years ago
  • 0.7.4                                ...           4 years ago
  • 0.7.3                                ...           4 years ago
  • 0.7.2                                ...           4 years ago
  • 0.7.1                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (6)
Dev Dependencies (0)
None

Copyright 2014 - 2017 © taobao.org |