Literate documentation generator
JavaScript CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
bin generate into .gh-pages Dec 3, 2014
gulp lint fixes Dec 3, 2014
public strip html from titles, css tweaks Dec 3, 2014
templates switch to ejs, add quality checks Jun 11, 2014
.dockit.json5 update deps Jul 7, 2015
.eslintrc
.gitignore generate into .gh-pages Dec 3, 2014
.jsbeautifyrc switch to ejs, add quality checks Jun 11, 2014
.npmignore
.travis.yml nojekyll Dec 3, 2014
LICENSE add license, support project assets in documentation Sep 2, 2013
README.md
gulpfile.js
index.js lint fixes Dec 3, 2014
package.json update deps Jul 7, 2015

README.md

View the Dockit documentation generated by Dockit

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


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