Skip to content

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.

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

Required

To run unit tests

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

About

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.

Resources

License

Packages

No packages published