dockit

automatic documentation generator

npm install dockit
108 downloads in the last week
216 downloads in the last month

View the Dockit documentation generated by Dockit

Dockit

Dockit is a documentation generator, inspired by docco, written in Literate JavaScript. It produces a set of HTML documents that display your comments intermingled with your code, for your entire project.

All prose is passed through Markdown, and code is passed through Highlight.js syntax highlighting. This page is the result of running Dockit against its own source files.

Dockit source is available on github

Installation

npm install -g dockit

Usage

Run inside a directory with a .dockit.json[5] file or pass the config location as a command line option, see dockit --help

npm loves you