view-engine-jade

Jade view engine

Installation

npm install view-engine-jade --save

Usage

Enable the Jade view engine:

require('view-engine').register(
    'jade',
    require('view-engine-jade'),
    {
        runtime: require('jade/runtime'), /* OPTIONAL */
        compiler: require('jade') /* OPTIONAL */
    });

The Jade view engine is now ready to be used elsewhere in your code (either client-side or server-side):

var templatePath = require.resolve('./hello.jade');
var template = require('view-engine').load(templatePath);

// Callback-style
template.render({ name: 'John'}, function(err, data) {
    if (err) {
        console.log('Failed to render: ' + err);
        return;
    }

    console.log('Output: ' + data);
});

// Streaming-style
var out = require('fs').createOutputStream('hello.out', {encoding: 'utf8'});
template.stream({ name: 'John'}).pipe(out);

// Render to an existing render context
template.render({ name: 'John'}, context);

It is recommended to use the RaptorJS Optimizer as the JavaScript bundler, along with the optimizer-jade plugin.

The client-side loader expects the Jade templates to be compiled to a CommonJS module and transported down to the client as code similar to the following:

module.exports=function(jade) {
    return function template(locals) {
        return /* compiled source produced by jade.compileClient(...) */;
    };
};

See the documentation for the view-engine module for more information.