Grunt Email Design Workflow

Designing and testing emails is a pain. HTML tables, inline CSS, various devices and clients to test, and varying support for the latest web standards.

This grunt task helps simplify things at the design stage.

Compiles your SCSS to CSS
Removes unused CSS (testing)
Builds your HTML and TXT email templates
Inlines your CSS
Minifies your HTML and CSS
Uploads any images to a CDN (optional)
Sends you a test email to your inbox (optional)

Requirements

Node.js - Install Node.js
Grunt-cli and Grunt (npm install grunt-cli -g)
Ruby - Install ruby with RVM
Premailer (gem install premailer hpricot nokogiri) - Inlines the CSS
Mailgun (optional) - Sends the email
Litmus (optional) - Tests the email across all clients/browsers/devices
Rackspace Cloud (optional) - Uses Cloud Files as a CDN

Getting started

If you haven't used Grunt before check out Chris Coyier's post on getting started with Grunt.

Clone this repo, cd to the directory, run npm install to install the necessary packages.

git clone https://github.com/leemunroe/grunt-email-design.git
cd grunt-email-design
npm install
grunt

Sensitive Information

We encourage you not to store sensitive data in your git repository. If you must, please look into git-encrypt or some other method of encrypting your configuration secrets.

Create a file secrets.json in your project root.
Paste the following sample code in secrets.json and enter the appropriate credentials for the services you want to connect with. It's ok to leave these defaults, but they should exist.

{
  "mailgun": {
    "api_key": "YOUR MG PRIVATE API KEY",
    "sender": "E.G. POSTMASTER@YOURDOMAIN.COM",
    "recipient": "WHO YOU WANT TO SEND THE EMAIL TO"
  },
  "litmus": {
    "username": "LITMUS USER NAME",
    "password": "LITMUS PASS",
    "company": "LITMUS COMPANY/API SUBDOMAIN NAME"
  },
  "cloudfiles": {
    "user": "CLOUDFILES USERNAME",
    "key": "CLOUDFILES KEY",
    "region": "CLOUDFILES REGION E.G. ORD",
    "container": "CLOUDFILES CONTAINER NAME",
    "uri": "CLOUDFILES URI"
  }
}

How it works

CSS

This project uses SCSS. You don't need to touch the .css files, these are compiled automatically.

For changes to CSS, modify the .scss files.

Sass variables in _settings.scss for background-color, typography and panels.

Media queries and responsive styles are in a separate style sheet so that they don't get inlined. Note that only a few clients support media queries e.g. iOS Mail app.

Email templates and content

Handlebars and Assemble are used for templating.

/layouts contains the standard header/footer HTML markup. You most likely will only need one layout template, but you can have as many as you like.

/emails is where your email content will go. To start you off I've included example transactional emails based on my simple HTML email template.

/data contains optional .yml or .json data files that can be used in your templates. It's a good way to store commonly used strings. See /data/default.yml and /partials/follow_lee.hbs for an example.

/partials contains optional .hbs files that can be thought of like includes. To use a partial, for example /partials/follow_lee.hbs you would use the following code in your emails template:

{{> follow_lee }}

Generate your email templates

In terminal, run grunt. This will:

Compile your SCSS to CSS
Remove unused CSS
Generate your email layout and content
Inline your CSS
Minify the HTML

See the output HTML in the dist folder. Open them and preview it the browser.

Alternatively run grunt watch. This will check for any changes you make to your .scss and .hbs templates, then automatically run the tasks. Saves you having to run grunt every time.

Send the email to yourself

Sign up for a Mailgun account (it's free)
Open up Gruntfile.js
Replace 'MAILGUN_KEY' with your actual Mailgun API key
Change the sender and recipient to your own email address (or whoever you want to send it to)

Run grunt send --template=transaction.html. This will email out the template you specify.

Change 'transaction.html' to the name of the email template you want to send.

How to test with Litmus

If you have a Litmus account and want to test the email in multiple clients/devices:

Open up Gruntfile.js
Replace username, password and yourcompany under the Litmus task with your credentials

Run grunt litmus --template=TEMPLATE_NAME.html to send the email to Litmus. This will create a new test using the <title> value of your template.

See the Litmus results for the simple transactional email template that is included.

CDN and working with image assets

If your email contains images you'll want to serve them from a CDN. This Gruntfile has support for Rackspace Cloud Files (pricing).

Sign up for a Rackspace Cloud account (use the Developer Discount for $300 credit)
Create a new Cloud Files container
Open up Gruntfile.js
Change 'cloudfiles' settings to your settings (you can find your Rackspace API key under your account settings)
Make any other config changes as per grunt-cloudfiles instructions

Run grunt cdnify to run the default tasks as well as upload any images to your CDN.

Run grunt cdnify send --template=branded.html to send the email to yourself with the 'CDNified' images.

Sample email templates

I've added two templates here to help you get started. (minus their custom styling)

For more transactional email templates check out Zurb Ink's collection of templates.

timripley/grunt-email-workflow