docpad-plugin-handlebars

Adds support for the Handlebars templating engine to DocPad.

npm install docpad-plugin-handlebars
37 downloads in the last day
177 downloads in the last week
500 downloads in the last month

Handlebars Plugin for DocPad

Build Status NPM version Dependency Status Development Dependency Status
Gittip donate button Flattr donate button PayPayl donate button BitCoin donate button

Adds support for the Handlebars templating engine to DocPad

Convention: .(inlinejs|js|anything).(handlebars|hbs|hb)

Install

npm install --save docpad-plugin-handlebars

Configuration

Getting helpers and partials to work

For the plugin to support helpers and partials, you'll have to add something like the following to your docpad configuration file manually:

# ...
plugins:
    handlebars:
        helpers:
            # Expose docpads 'getBlock' function to handlebars
            getBlock: (type, additional...) ->
                additional.pop() # remove the hash object
                @getBlock(type).add(additional).toHTML()
        partials:
            title: '<h1>{{document.title}}</h1>'
            goUp: '<a href="#">Scroll up</a>'
# ...

Usage as precompiler

If the document extension is .(inlinejs|js).(handlebars|hbs|hb), the plugin will produce a precompiled template. In this case, you can customise the precompiled template via the following:

# ...
plugins:
    handlebars:
        precompileOpts:
            wrapper: "default"
# ...

Available values for the wrapper option are:

  • "default": Produces a handlebars wrapper like:

      (function() {
          var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
          templates['theSlugOfTheFile'] = template(function (Handlebars,depth0,helpers,partials,data) {
              ...
          })
      })();
    
  • "amd": Produces a AMD handlebars wrapper like:

      define(['handlebars'], function(Handlebars) {
          var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
          templates['theSlugOfTheFile'] = template(function (Handlebars,depth0,helpers,partials,data) {
              ...
          });
      });
    
  • "none": Produces a basic wrapper like:

      function (Handlebars,depth0,helpers,partials,data) {
          ...
      }
    

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gittip donate button Flattr donate button PayPayl donate button BitCoin donate button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Mike Moulton mike@meltmedia.com (http://meltmedia.com)

npm loves you