Package Exports

assemble-render-file

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 (assemble-render-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

assemble-render-file

Assemble plugin for rendering views in a vinyl pipeline.

Install

Install with npm:

$ npm install assemble-render-file --save

Usage

var renderFile = require('assemble-render-file');
var assemble = require('assemble');

// register as an instance plugin with assemble
var app = assemble()
  .use(renderFile());

// then use in a vinyl pipeline
app.src('*.hbs')
  .pipe(app.renderfile())
  .pipe(app.dest('foo'));

noop engine

By default, when no engine is found for a file an error is thrown. To get around this you can either define a noop engine, or use disable the engineStrict option.

A noop engine follows the same signature as any engine, but must be registered using the key: noop.

Example

app.engine('noop', function(view, opts, next) {
  // do whatever you want to `view`, or nothing
  next(null, view);
});

Options

options.engineStrict

By default, when no engine is found for a file an error is thrown. This can be disabled with the following:

app.option('engineStrict', false);

When disabled and an engine is not found, files are just passed through.

You might also be interested in these projects:

assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage
assemble-streams: Assemble pipeline plugin for pushing a view collection into a vinyl stream. | homepage
assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

This file was generated by verb, v0.9.0, on May 24, 2016.