darbak

Compiles literate-iced-coffee-script and append it with its source and parsed documentation.

Useful for creating Docco-like code pages that can run while being displayed, compile with client side templates, and be edited on the client side.

Installation

Using node:

npm install darbak --save-dev

The code is written in coffee-script so you may need to install node's coffee-script globally:

npm install -g coffee-script

Includes a grunt plugin

Requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

Once the plugin node package has been installed, it may be enabled inside your Gruntfile with this line of coffee-script:

grunt.loadNpmTasks 'darbak'

The "darbak" task

Overview

Run this task with the grunt darbak command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.