Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (40 sloc) 1.68 KB


Bringing the literate programing tool Docco to Connect.

The idea is just to generate documentation dynamically upon request, which is quite handy during development.

New Hot Stuff: Docco + + watch = Save file → documentation page updates automatically.


npm install connect-docco -g

If you don't intend to use the connect-docco program, you can omit the -g flag.

Command-Line Usage

The arguments below are the defaults and can be omitted.

connect-docco --port 8082 --dirname .

Middleware Usage

Here is an example of a basic server setup:


The middleware handles any Docco-compatible extension (.coffee, .js, .json, .rb, .py). You can still view the raw version of the file when the ?raw query string parameter is given, should you wish to use it:

http://localhost:8082/some/file.js?raw + watch

If given a Connect (or Express) application, the Docco middleware will watch for file changes using watch and emit changes over

var app = connect.createServer();

  .use(docco(__dirname, { app: app }))

This is basic, but ends up working pretty well.

Jump to Line
Something went wrong with that request. Please try again.