This package has been deprecated

Author message:

this package is no longer maintained

dockit

1.0.0 • Public • Published

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)

Package Sidebar

Install

npm i dockit

Weekly Downloads

14

Version

1.0.0

License

MIT

Last publish

Collaborators

  • diffsky