Skip to content
This repository has been archived by the owner on Nov 10, 2020. It is now read-only.

Latest commit

 

History

History
54 lines (36 loc) · 1.3 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.3 KB
Raw

Ueno Newsletter

Newsletter email templates

The HTML email templates for Ueno's wonderful newsletter. They use Foundation for Emails components and CSS, and are compiled with Handlebars.

Installation

git clone [email protected]:ueno-llc/newsletter
cd newsletter
npm install

Usage

To work on the emails:

npm start

Here's how the files are structured:

  • /src/pages: each page here is an email template.
  • /src/layouts: the wrapper HTML used for each template is here.
  • /src/partials: reusable bits of HTML are stored here as Handlebars partials.
  • /src/helpers: functions in this folder can be used as Handlebars helpers.
  • /src/assets: static assets are stored here.
  • /src/styles: Sass files are here.
  • /src/data: extra data for Handlebars is here.

Deployment

To create ZIP bundles:

npm run build

A ZIP file will be created with the CSS inlined into the email, and all images referenced by the email included. You can upload these ZIP files to Mailchimp to create a template.

Testing

Based on the metrics of our mailing list, we test in these email clients:

  • Gmail: Web, iOS
  • G Suite: Web
  • Outlook: 2016
  • Mail.app: iOS, macOS

License

MIT © ueno.