To help you get started, we've collected the most common ways that jade is being used within popular public projects.

popeindustries / buddy / packages / buddy-plugin-jade / index.js View on Github

exports.compile = function (content, options, fn) {
  // Copy data to root
  options = Object.assign({}, options, DEFAULT_OPTIONS, options.data);

  jade.render(content, options, (err, content) => {
    if (err) {
      err.filepath = options.filepath;
      return fn(err);
    }
    fn(null, content);
  });
};

View more ways to use jade

Full documentation is at jade-lang.com

Jade is a high performance template engine heavily influenced by Haml and implemented with JavaScript for node and browsers. For bug reports, feature requests and questions, open an issue. For discussion join the chat room.

You can test drive Jade online here.

Installation

via npm:

$ npm install jade

Syntax

Jade is a clean, whitespace sensitive syntax for writing html. Here is a simple example:

doctype html
html(lang="en")
  head
    title= pageTitle
    script(type='text/javascript').
      if (foo) bar(1 + 5)
  body
    h1 Jade - node template engine
    #container.col
      if youAreUsingJade
        p You are amazing
      else
        p Get on it!
      p.
        Jade is a terse and simple templating language with a
        strong focus on performance and powerful features.

becomes

  
    <title>Jade</title>
    
  
  
    <h1>Jade - node template engine</h1>
    <div class="col" id="container">
      <p>You are amazing</p>
      <p>Jade is a terse and simple templating language with a strong focus on performance and powerful features.</p>
    </div>
  

The official jade tutorial is a great place to start. While that (and the syntax documentation) is being finished, you can view some of the old documentation here and here

API

For full API, see jade-lang.com/api

var jade = require('jade');

// compile
var fn = jade.compile('string of jade', options);
var html = fn(locals);

// render
var html = jade.render('string of jade', merge(options, locals));

// renderFile
var html = jade.renderFile('filename.jade', merge(options, locals));

Options

• filename Used in exceptions, and required when using includes
• compileDebug When false no debug instrumentation is compiled
• pretty Add pretty-indentation whitespace to output (false by default)

Browser Support

The latest version of jade can be download for the browser in standalone form from here. It only supports the very latest browsers though, and is a large file. It is recommended that you pre-compile your jade templates to JavaScript and then just use the runtime.js library on the client.

To compile a template for use on the client using the command line, do:

$ jade --client --no-debug filename.jade

which will produce filename.js containing the compiled template.

Command Line

After installing the latest version of node, install with:

$ npm install jade -g

and run with

$ jade --help

Additional Resources

Tutorials:

• cssdeck interactive Jade syntax tutorial
• cssdeck interactive Jade logic tutorial
• Jade について。 (A Japanese Tutorial)
• Jade - 模板引擎

Implementations in other languages:

• php
• scala
• ruby
• python
• java

Other:

• Emacs Mode
• Vim Syntax
• TextMate Bundle
• Coda/SubEtha syntax Mode
• Screencasts
• html2jade converter
• jade2php converter
• Jade Server Ideal for building local prototypes apart from any application

License

MIT