https://github.com/pdehaan/dockit

Literate Documentation Generator
https://github.com/pdehaan/dockit

Last synced: 22 days ago
JSON representation

Literate Documentation Generator

• Host: GitHub
• URL: https://github.com/pdehaan/dockit
• Owner: pdehaan
• License: mit
• Created: 2014-08-14T22:22:10.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-08-14T22:22:37.000Z (over 10 years ago)
• Last Synced: 2024-12-19T15:07:01.274Z (about 1 month ago)
• Homepage: http://diffsky.com/dockit
• Size: 266 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

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