Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: fe1b5352a8
Fetching contributors…

Cannot retrieve contributors at this time

61 lines (40 sloc) 1.721 kb

connect-docco

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 + Socket.io + watch = Save file → documentation page updates automatically.

Installation

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:

connect.createServer()
    .use(connect.logger())
    .use(require("docco")(__dirname))
    .use(connect.directory(__dirname))
    .use(connect.static(__dirname))
    .listen(process.env.PORT);

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

socket.io + watch

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

var app = connect.createServer();

app
  .use(connect.logger())
  .use(docco(__dirname, { app: app }))
  .use(connect.directory(__dirname))
  .use(connect.static(__dirname))
  .listen(process.env.PORT);

This is basic, but ends up working pretty well.

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