docco-xt

Docco-XT is a fork of Docco that tackles some of the problems Docco is having with larger codebases.

Therefore, an additional option to specify a base directory was added. When used, all documented files are displayed with paths relative to the given directory. This not only allows for documenting of multiple files having the same name, but also helps getting a better overview over the documented codebase.

Additionally, filenames can be searched when used in parallel layout:

To search for a filename, press [ESC] or focus the search input manually. When you type in a filename or parts of it, you can navigate the filtered results with [↓] and [↑] and view the selected result with [ENTER].

For more information on Docco, see: http://jashkenas.github.com/docco/

Installation:

sudo npm install -g docco-xt

Usage: docco [options] files

Options:

-h, --help              output usage information
-V, --version           output the version number
-L, --languages [file]  use a custom languages.json
-l, --layout [name]     choose a layout (parallel or linear)
-o, --output [path]     output to a given folder
-c, --css [file]        use a custom css file
-t, --template [file]   use a custom .jst template
-b, --basedir [path]    use a given folder as base directory for relative
                        paths
-e, --extension [ext]   assume a file extension for all inputs

Release History:

2014-01-03   v0.1.0 Initial release. 2014-01-06   v0.1.1 Fixes positioning of pilcrows. If a title exists, display it instead of the filename.