{"id":13397773,"url":"https://github.com/foundation/foundation-emails","last_synced_at":"2025-12-17T00:05:40.879Z","repository":{"id":10691867,"uuid":"12933501","full_name":"foundation/foundation-emails","owner":"foundation","description":"Quickly create responsive HTML emails that work on any device and client. Even Outlook.","archived":false,"fork":false,"pushed_at":"2024-06-13T07:20:42.000Z","size":8865,"stargazers_count":7784,"open_issues_count":192,"forks_count":1094,"subscribers_count":241,"default_branch":"develop","last_synced_at":"2025-05-01T07:03:41.946Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://get.foundation/emails/docs/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-09-18T20:13:27.000Z","updated_at":"2025-04-29T12:46:38.000Z","dependencies_parsed_at":"2025-04-23T12:15:30.614Z","dependency_job_id":null,"html_url":"https://github.com/foundation/foundation-emails","commit_stats":{"total_commits":891,"total_committers":132,"mean_commits":6.75,"dds":0.8282828282828283,"last_synced_commit":"9e371709f93bbe99e897db6b9976115c0aba45d3"},"previous_names":["zurb/foundation-emails","zurb/ink"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Ffoundation-emails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Ffoundation-emails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Ffoundation-emails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Ffoundation-emails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foundation","download_url":"https://codeload.github.com/foundation/foundation-emails/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253154977,"owners_count":21862623,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T18:01:44.136Z","updated_at":"2025-12-12T04:34:26.304Z","avatar_url":"https://github.com/foundation.png","language":"HTML","readme":"# [Foundation for Emails](https://get.foundation/emails)\n\n[![npm version badge](https://img.shields.io/npm/v/foundation-emails.svg)](https://www.npmjs.org/package/foundation-emails)\n[![downloads badge](http://img.shields.io/npm/dm/foundation-emails.svg)](https://www.npmjs.org/package/foundation-emails)\n[![Gem Version](https://badge.fury.io/rb/foundation_emails.svg)](https://badge.fury.io/rb/foundation_emails)\n[![downloads badge](http://img.shields.io/npm/l/foundation-emails.svg)](https://www.npmjs.org/package/foundation-emails)\n[![CDNJS](https://img.shields.io/cdnjs/v/foundation-emails.svg)](https://cdnjs.com/libraries/foundation-emails)\n\n\nFoundation for Emails (previously known as Ink) is a framework for creating responsive HTML emails that work in any email client \u0026mdash; even Outlook. Our HTML/CSS components have been tested across every major email client to ensure consistency. And with the [Inky](https://github.com/zurb/inky) templating language, writing HTML emails is now even easier.\n\n## Getting Started\n\nThe main way to get started is with our [email template stack](https://github.com/zurb/foundation-emails-template). To use the stack, you'll need [Node.js](https://nodejs.org/en/) no greater than version 10 installed on your machine.\n\n`nvm` installation instructions can be found [here](https://github.com/nvm-sh/nvm#install--update-script)\n\nTo set up the emails template, run these commands:\n\n```bash\ngit clone https://github.com/zurb/foundation-emails-template project\ncd project\nnvm install 10\nnvm use 10\nnpm install\n```\n\nThen run `npm start` to run the project. A new browser window will open with a BrowserSync server showing the finished files.\n\nRun `npm run build` to do a full email inlining process.\n\n\n#### Using the Ruby gem\n\n**foundation_emails** is a gem that enables you to use Foundation for Emails assets within a Rails project. To install in your app:\n\n1. Add the following line to your Gemfile:\n\n  ```ruby\n  gem 'foundation_emails'\n  ```\n\n2. Then execute:\n\n  ```bash\n  bundle install\n  ```\n\n3. Import Foundation for Emails in your emails' stylesheet(s):\n\n  ```scss\n  // app/assets/stylesheets/your_emails_stylesheet.scss\n\n  @import \"foundation-emails\";\n  ```\n\nAdding Inky's templating capabilities to Rails is easy thanks to the [**inky-rb**](https://github.com/zurb/inky-rb) gem, which bundles `foundation_emails` by default.\n\n## Documentation\n\n**Check out our [Migration Guide](https://github.com/zurb/foundation-emails/blob/master/migration.md) for upgrading an existing template or for more in-depth code examples.**\n\nFoundation for Emails 2.0 documentation and framework are on the `develop` branch and you can compile it on your own machine.\n\nRun these commands to set up the documentation:\n\n```bash\ngit clone https://github.com/zurb/foundation-emails.git\ncd foundation-emails\n```\n\nFoundation for Emails 2.0 documentation is on the `develop` branch.\n\n```bash\ngit fetch\ngit checkout develop\nnpm install\n```\n\nThen run `npm start` to compile the documentation. When it finishes, a new browser window will open pointing to a BrowserSync server displaying the documentation.\n\n## Testing\n\nRun `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.\n\n## Inky\n\n[Inky](https://github.com/zurb/inky) is our new templating language that converts simple HTML into the complex tables required for email layout.\n\nThe parser converts a set of custom HTML tags, expanding them out into full HTML syntax. Below is a list of every custom element.\n\n### Grid\n\n```html\n\u003ccontainer\u003e\n  \u003crow\u003e\n    \u003ccolumn small=\"12\" large=\"4\"\u003e\u003c/column\u003e\n    \u003ccolumn small=\"12\" large=\"8\"\u003e\u003c/column\u003e\n  \u003c/row\u003e\n\u003c/container\u003e\n```\n\n### Block Grid\n\n```html\n\u003cblock-grid up=\"3\"\u003e\n  \u003ctd\u003e\u003c/td\u003e\n  \u003ctd\u003e\u003c/td\u003e\n  \u003ctd\u003e\u003c/td\u003e\n\u003c/block-grid\u003e\n```\n\n### Components\n\n```html\n\u003cbutton href=\"http://zurb.com\"\u003e\u003c/button\u003e\n```\n\n```html\n\u003cmenu\u003e\n  \u003citem href=\"one.html\"\u003eItem One\u003c/item\u003e\n  \u003citem href=\"one.html\"\u003eItem Two\u003c/item\u003e\n  \u003citem href=\"one.html\"\u003eItem Three\u003c/item\u003e\n\u003c/menu\u003e\n```\n\n## Contributing\n\nAs an open source project, we looooove our community support. Please file issues, or better yet pull requests on the [Foundation for Emails Repo](https://github.com/zurb/foundation-emails). We're stoked to hear your feedback, make improvements, and keep evolving Foundation for Emails!\n\nCopyright (c) 2018 ZURB, inc.\n","funding_links":[],"categories":["HTML","Github Repositories","Code"],"sub_categories":["Frontend Development","Templating"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundation%2Ffoundation-emails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoundation%2Ffoundation-emails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundation%2Ffoundation-emails/lists"}