assemble / assemble-handlebars-helpers

A handful of helpers that replace the built-in Handlebars helpers, with changes made for handling assemble specifics like context and errors.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

assemble-handlebars-helpers NPM version NPM downloads Build Status

Default helpers for use in assemble to replace the built-in Handlebars helpers.

Install

Install with npm:

$ npm install assemble-handlebars-helpers --save

Usage

Register the helpers with an assemble instance called app.

var assemble = require('assemble');
var app = assemble();
app.helpers(require('assemble-handlebars-helpers'));

Helpers

each

Iterate over an array or object's key/value pairs.

Example

{{#each arr}}
  {{this}}
{{/each}}

if

Example

{{#if foo}}
  {{foo}}
{{else}}
  {{bar}}
{{/if}}

log

Example

{{log foo}}

lookup

Returns a value from an object by the property name.

Example

{{lookup foo "bar"}}

{{! as a subexpression }}
{{#each (lookup foo "items")}}
  {{this}}
{{/each}}

unless

Example

{{#unless foo}}
  {{foo}}
{{else}}
  {{bar}}
{{/unless}}

with

Example

{{#with foo}}
  {{bar}}
{{/with}}

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

Brian Woodward

License

Copyright © 2016, Brian Woodward. Released under the MIT license.


This file was generated by verb, v0.9.0, on April 25, 2016.

About

A handful of helpers that replace the built-in Handlebars helpers, with changes made for handling assemble specifics like context and errors.

License:MIT License


Languages

Language:JavaScript 100.0%