❤Never Pet Marmots

    npm

    Sign UpSign In

    This package has been deprecated

    Author message:

    Jade has been renamed to pug, please install the latest version of pug instead of jade

    jade
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/jade package

    1.11.0 • Public • Published

    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

    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

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <title>Jade</title>
        <script type="text/javascript">
          if (foo) bar(1 + 5)
        </script> 
      </head>
      <body>
        <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>
        </div>
      </body>
    </html>

    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:

    Implementations in other languages:

    Other:

    License

    MIT

    Keywords

    none

    Install

    npm i jade

    Repository

    Gitgithub.com/jadejs/jade

    Homepage

    jade-lang.com

    DownloadsWeekly Downloads

    474,684

    Version

    1.11.0

    License

    MIT

    Last publish

    Collaborators

    • forbeslindesay
    Try on RunKit
    Report malware