Package Exports

engines

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (engines) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

engines

Template engine consolidation library.

This is a fork of consolidate.js, modified

Installation

$ npm install engines

Supported template engines

NOTE: you must still install the engines you wish to use, add them to your package.json dependencies.

API

All templates supported by this library may be rendered using the signature (path[, context], callback) as shown below, which is the same signature that Assemble supports, so any of these engines may be used within Assemble.

NOTE: All this example code uses engines.handlebars for the Handlebars template engine. Replace handlebars with whatever template engine you prefer. For example, use engines.hogan for hogan.js, engines.jade for jade, etc.

Run console.log(engines) for the full list of identifiers.

Examples:

var engines = require('engines');
engines.handlebars('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Or without options / local variables:

var engines = require('engines');
engines.handlebars('templates/about.hbs', function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

To dynamically pass the engine, use the subscript operator and a variable:

var engines = require('engines');
var name = 'handlebars';

engines[name]('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Caching

To enable caching pass { cache: true }. Engines may use this option to cache things reading the file contents, like compiled Functions etc. Engines which do not support this may simply ignore it. All engines that engines implements I/O for will cache the file contents, this is ideal for production environments.

var engines = require('engines');
engines.handlebars('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Assemble > 0.6 example

var assemble = require('assemble')
    engines = require('engines');

// assign the handlebars engine to .hbs files
assemble.engine('hbs', engines.handlebars);

// assign the marked engine to .md files
assemble.engine('md', engines.marked);

// Run assemble
assemble()
  .src('templates/*.hbs')
  .src('content/*.md')
  .dest()

assemble.build();

Notes

You can pass partials with options.partials
For using template inheritance with nunjucks, you can pass a loader with options.loader.

Running tests

Install dev deps:

$ npm install -d

License

Released under the MIT license