[View the Dockit documentation generated by Dockit](http://diffsky.github.io/dockit/index.html#readme_md-s1)

# [![dockit](https://raw.githubusercontent.com/diffsky/dockit/master/assets/dockit-64.png)](https://github.com/diffsky/dockit) Dockit

Dockit is a documentation generator, inspired by [docco](http://jashkenas.github.com/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](https://github.com/diffsky/dockit)

## 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`

---

Dockit logo designed by [Ilsur Aptukov](http://thenounproject.com/Ilsur) from the [Noun Project](http://thenounproject.com/) :: Creative Commons – Attribution (CC BY 3.0)