README.md

Distillery

Current Version: v0.3.0 (2011-05-25)

License: MIT (see included LICENSE file)

Author: Kevin P. Albrecht - http://www.kevinalbrecht.com

Web Site: http://www.github.com/onlyafly/distillery

What is Distillery?

Distillery is a Node.js program which extracts multiline comments that start with /*** (a forward slash and three asterisks) of Markdown-formatted text from a JavaScript file, then generates an HTML file from the results.

Dependencies

Included

• showdown.js - https://github.com/fivesixty/mdext

Required

• Node - https://github.com/joyent/node

To run unit tests

• nodeunit - https://github.com/caolan/nodeunit

Running Distillery

From the root folder, run this:

> node distillery.js

Running the Examples

From the root/examples folder, run this to regenerate output1.html from input.js:

> . example1.sh

You can also regenerate output2.html from the README.js file:

> . example2.sh

Running the Unit Tests

From the root folder, run this:

> nodeunit tests