A clean, whitespace-sensitive template language for writing HTML

  • jade

Downloads in past


1.11.09 years ago13 years agoMinified + gzip package size for jade in KB


Jade - Node Template Engine
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.
Build Status Coverage Status Dependency Status devDependencies Status NPM version Join Gitter Chat


via npm:
$ npm install jade


Jade is a clean, whitespace sensitive syntax for writing html. Here is a simple example:
doctype html
    title= pageTitle
      if (foo) bar(1 + 5)
    h1 Jade - node template engine
      if youAreUsingJade
        p You are amazing
        p Get on it!
        Jade is a terse and simple templating language with a
        strong focus on performance and powerful features.

<!DOCTYPE html>
<html lang="en">
    <script type="text/javascript">
      if (foo) bar(1 + 5)
    <h1>Jade - node template engine</h1>
    <div id="container" class="col">
      <p>You are amazing</p>
      <p>Jade is a terse and simple templating language with a strong focus on performance and powerful features.</p>

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


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));


- 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

- cssdeck interactive Jade syntax tutorial - cssdeck interactive Jade logic tutorial - Jade について。 (A Japanese Tutorial) - Jade - 模板引擎
Implementations in other languages:
- php - scala - ruby - python - java
- 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