Need help with foundation-emails?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

foundation
7.4K Stars 1.0K Forks MIT License 1.1K Commits 177 Opened issues

Description

Quickly create responsive HTML emails that work on any device and client. Even Outlook.

Services available

!
?

Need anything else?

Contributors list

No Data

Foundation for Emails

npm version badge downloads badge Gem Version downloads badge CDNJS

Foundation for Emails (previously known as Ink) is a framework for creating responsive HTML emails that work in any email client — even Outlook. Our HTML/CSS components have been tested across every major email client to ensure consistency. And with the Inky templating language, writing HTML emails is now even easier.

Getting Started

The main way to get started is with our email template stack. To use the stack, you'll need Node.js installed on your machine.

To set up the emails template, run these commands:

git clone https://github.com/zurb/foundation-emails-template project
cd project
npm install

Then run

npm start
to run the project. A new browser window will open with a BrowserSync server showing the finished files.

Run

npm run build
to do a full email inlining process.

Using the Ruby gem

foundation_emails is a gem that enables you to use Foundation for Emails assets within a Rails project. To install in your app:

  1. Add the following line to your Gemfile:
  gem 'foundation_emails'
  1. Then execute:
  bundle install
  1. Import Foundation for Emails in your emails' stylesheet(s):
  // app/assets/stylesheets/your_emails_stylesheet.scss

@import "foundation-emails";

Adding Inky's templating capabilities to Rails is easy thanks to the inky-rb gem, which bundles

foundation_emails
by default.

Documentation

Check out our Migration Guide for upgrading an existing template or for more in-depth code examples.

Foundation for Emails 2.0 documentation and framework are on the

develop
branch and you can compile it on your own machine.

Run these commands to set up the documentation:

git clone https://github.com/zurb/foundation-emails.git
cd foundation-emails

Foundation for Emails 2.0 documentation is on the

develop
branch.
git fetch
git checkout develop
npm install

Then run

npm start
to compile the documentation. When it finishes, a new browser window will open pointing to a BrowserSync server displaying the documentation.

Testing

Run

npm run test:visual
to compile the visual regression tests. All of the pages under
test/visual/pages
are compiled and inlined. From there, they can be uploaded to Litmus for testing.

Inky

Inky is our new templating language that converts simple HTML into the complex tables required for email layout.

The parser converts a set of custom HTML tags, expanding them out into full HTML syntax. Below is a list of every custom element.

Grid

  
    
    
  

Block Grid

  
  
  

Components


  Item One
  Item Two
  Item Three

Contributing

As an open source project, we looooove our community support. Please file issues, or better yet pull requests on the Foundation for Emails Repo. We're stoked to hear your feedback, make improvements, and keep evolving Foundation for Emails!

Copyright (c) 2018 ZURB, inc.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.