handlebars-email-template

A handlebars email template.


Keywords
handlebars, handlebars-email-template
License
ISC
Install
npm install handlebars-email-template@1.2.3

Documentation

Handlebars Email Template

Build Status

Using handlebars to create your email templates with ease.

Setup

npm install handlebars-email-template

Folder Structure

- data
  data.json
- views
    - partials
        table-row.hbs
    email.hbs
- index.js

Email Template HTML

You can use the HTML Snippets - Email Template as a starting point for your template.

Usage

var handlebarsEmailTemplate = require('handlebars-email-template');

var options = {
    root: 'views', // This is the root of your templates folder
    src: '_partials', // Partials folder
    dest: 'compiled', // Destination directory
    srcTemplate: 'email', // Src Template
    destTemplate: 'email', // Destination Template Name
    ext: 'hbs',
    data: 'data/data.json' // Path to data file
};

handlebarsEmailTemplate(options);

// Expected output

//- compiled
//  - email.html

Options

  • root - This is the root of your templates directory
  • src - Partials directory
  • dest - Output directory
  • srcTemplate - Name of the template eg: email.hbs
  • destTemplate - Name of output file.
  • data - path to data.