INTRO.md View source

Welcome to Lidoc

Lidoc generates literate programming documentation from your code painlessly.

It takes any code project, parses its inline comments, and and generates documentation in the form of a gorgeous-looking, standalone HTML package like this one.

Lidoc is code-agnostic; it doesn't care about your code at all, just the comments. As a result, it supports Python, PHP, Ruby, CoffeeScript, JavaScript, and just about anything that supports comments.

Heavily inspired by jashkenas/docco, which this project actually takes code from.

Installation

Install NodeJS in your preferred manner. Then:

$ npm install -g lidoc

Usage

Build documentation like so:

$ lidoc **/*.js --output docs

Or you can view the documentation index as a JSON file like so:

$ lidoc **/*.js --index

Acknowledgements

© 2012, Rico Sta. Cruz. Released under the MIT License.

Lidoc is authored and maintained by Rico Sta. Cruz with help from its contributors. It is sponsored by my startup, Nadarei, Inc.

Fork me on Github