assemble-render-string

assemble-render-string

Assemble plugin that adds a .renderString method for rendering a string with any registered engine.

Install

Install with npm:

$ npm i assemble-render-string --save

Usage

var renderString = require('assemble-render-string');
var assemble = require('assemble');
var app = assemble();

app.use(renderString());

// optionally define the default engine to use
app.engine('txt', require('engine-base'));
app.use(renderString('txt'));

// render a string
var locals = { letter: 'B' };
app.renderString('A <%= letter %> C', locals, function(err, str) {
  if (err) throw err;
  console.log(str);
  //=> 'A B C'
});

API

.renderString

Render a string with the given locals and callback.

Params

• string {String}: The string to render
• locals {Object}: Locals to pass to the rendering engine.
• callback {Function}

Example

var locals = {title: 'Foo'};
app.renderString('Name: <%= title %>', locals, function(err, str) {
  if (err) throw err;
  console.log(str);
  //=> 'Name: Foo'
});

Related projects

• assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
• assemble-permalinks: Assemble plugin for easily creating permalinks (Assemble ^0.6.0) | homepage
• assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb on January 21, 2016.