automatic documentation generator

View the Dockit documentation generated by 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

npm install -g dockit

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

Dockit logo designed by Ilsur Aptukov from the Noun Project :: Creative Commons – Attribution (CC BY 3.0)