Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Grunt.js plugin to compile jade templates to JavaScript functions (normal or AMD) or plain HTML
JavaScript
branch: master

This branch is 2 commits ahead of richardbutler:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
example
support
tasks
test
.gitignore
.npmignore
LICENSE-MIT
README.md
grunt.js
package.json

README.md

grunt-jade

Compile jade templates with grunt.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-jade

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-jade');

Documentation

To your grunt.js gruntfile, add:

jade: {
  no_options: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path'
  }
}

For AMD compilation, add: (dependencies is what you want the runtime to be named)

jade: {
  amd: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    wrapper: {
      amd: true,
      dependencies: 'jade'
    }
  }
}

For node-style (Modules/1.0) compilation, add: (dependencies is what you want the runtime to be named)

jade: {
  node: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    wrapper: {
      node: true,
      dependencies: 'runtime'
    }
  }
}

For debug compilation, add:

jade: {
  debug: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    options: {
      compileDebug: true
    }
  }
}

For HTML compilation (instead of JS), add:

jade: {
  html: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    options: {
      client: false
    }
  }
}

For unwrapped functions, add:

jade: {
  unwrapped: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    wrapper: {
      wrap: false
    }
  }
}

For no runtime file, add:

jade: {
  no_runtime: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    options: {
      runtime: false,
    }
  }
}

Defaults

options: {
  client: true,
  runtime: true,
  compileDebug: false
}

wrapper: {
  wrap: true,
  amd: false,
  dependencies: ''
}

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.

Release History

(Nothing yet)

License

Copyright (c) 2012 Blaine Bublitz Licensed under the MIT license.

Something went wrong with that request. Please try again.