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 v0.6.x example

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

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

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

// Configure assemble
assemble.task('default', function() {
  assemble.src(['templates/*.hbs', 'content/*.md'])
    .pipe(assemble.dest('dist'))
});

Running tests

Install dev dependencies:

npm install -d && mocha

License

Released under the MIT license.

Keywords

FAQs

What is engines?

Is engines well maintained?

Package last updated on 17 Aug 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install