handlebars-helper-include

handlebars-helper-include

Handlebars helper for using includes.

Install

Use npm to install the package: npm i handlebars-helper-include.

Register the helper

Register the helper in the assemble task in your project's Gruntfile to begin using it in templates:

grunt.initConfig({
  assemble: {
    options: {
      // the 'handlebars-helper-include' npm module must also be listed in
      // devDependencies for assemble to automatically resolve the helper
      helpers: ['handlebars-helper-include', 'foo/*.js']
    },
    files: {
      '_gh_pages/': ['templates/*.hbs']
    }
  }
});

Usage

Register includes

Tell assemble where to find the includes by adding an includes property to the task options:

assemble: {
  options: {
    includes: ['abc.hbs', 'xyz.hbs', 'foo/*.hbs']
  },
  files: {
    '_gh_pages/': ['templates/*.hbs']
  }
}

Use in templates

Define the name of the helper to include, without file extension:

{{include 'abc'}}

Optionally pass a context as the second parameter:

{{include 'xyz' this}}

Wildcard patterns

Globbing patterns may also be used:

{{include 'chapter-*'}}

Contributing

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

Author

Jon Schlinkert

• github/helpers
• twitter/helpers

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

This file was generated by verb-cli on November 09, 2014.