mimosa-jade/README.md

A Jade client template compiler for Mimosa 2.0+

mimosa-jade
===========

## Overview

This is a Jade compiler for the Mimosa build tool. This module is for use with Mimosa `2.0+`.  This replicates the functionality of the Jade compiler that was built into Mimosa before `2.0`.

For more information regarding Mimosa, see http://mimosa.io

## Usage

Add `'jade'` to your list of modules.  That's all!  Mimosa will install the module for you when you start `mimosa watch` or `mimosa build`.

## Functionality

This module will compile Jade files during `mimosa watch` and `mimosa build`.

This module utilizes all of the built-in template behavior that comes with Mimosa's basic template compiler.  See the [mimosa website](http://mimosa.io/compilers.html#mt) for more information about how templates are treated or check out the various [`template` configuration options](http://mimosa.io/configuration.html#templates).

## Default Config

```coffeescript
jade:
  lib: undefined
  extensions: [ "jade" ]
  compileOptions:
    compileDebug: false
```

* `lib`: You may want to use this module but may not be ready to use the latest version of Jade. Using the `lib` property you can provide a specific version of Jade if the one being used by this module isn't to your liking. To provide a specific version, you must have it `npm install`ed into your project and then provide it to `lib`. For instance: `lib: require('jade')`. To use a version of jade prior to `1.0`, use mimosa-jade `1.0.1`.
* `extensions`: an array of strings, the extensions of your Jade files.
* `compileOptions`: an object to be passed to `jade.compile`.