generator-email

Email generator

Yeoman generator to help ease the development of HTML emails.

Features

The Email generator eases the process of HTML email development by providing you with:

• a local development server with LiveReload functionality.
• a boilerplate HTML template to get you started.
• the ability to develop with external CSS or Sass (SASS/SCSS) stylesheets.
• automatic inlining of the external CSS styles in your template.
• automatic compression & optimization of all your image assets.
• optimized CSS & HTML by removing unused comments and selectors from your code.

Getting Started

You'll need to make sure you've downloaded & installed the generator and all of its dependencies. You can do this by running the following commands:

• npm install -g yo - Installs Yeoman.
• npm install -g generator-email - Install the Email generator.
• gem install premailer - Installs Premailer.

Usage

To generate the email development environment, type: yo email and answer the questions asked by the generator.

The following tasks will now be made available to you via Grunt to help you develop and distribute your HTML emails.

• grunt start - starts a web server, opens the browser, and refreshes the page when changes occur.
• grunt build:development - manually compiles the development build.
• grunt build:distribution - manually compiles the distribution build.

The generator will also scaffold out the following file & folder structure for you.

├── dist
│   ├── images
│   └── index.html
├── src
│   ├── css
│   │   └── core.{css,scss,sass}
│   ├── images
│   └── index.html
├── Gruntfile.js
└── package.json

• src/ - source files that you should develop with.
• dist/ - compiled build files suitable for distribution. Created by running grunt build:distribution

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

License

Copyright (c) 2014 Jason Bellamy
Licensed under the MIT license.