vtex-email-framework

Transactional emails development architecture

Usage no npm install needed!

<script type="module">
  import vtexEmailFramework from 'https://cdn.skypack.dev/vtex-email-framework';
</script>

README

VTEX Email Framework

Badge Badge Badge

Transactional emails development architecture

๐ŸŽฎ Commands

npm yarn
npm install yarn install
npm run dev yarn dev
npm run build yarn build

โš”๏ธ Features

  • Sass
  • Hot Reload
  • Partial Files
  • Inline CSS
  • Dashboard
  • Boilerplate
  • Email Stylelint
  • Template Engine

๐Ÿ—บ๏ธ Guide

  • Data and template file name must be the same
emails
โ”‚
โ””โ”€โ”€โ”€json
โ”‚   โ”‚   order-confirmation.json
โ”‚   โ”‚   payment-approved.json
โ””โ”€โ”€โ”€templates
    โ”‚   order-confirmation.hbs
    โ”‚   payment-approved.hbs
    โ””โ”€โ”€โ”€partials
        โ”‚   Header.hbs
        โ”‚   Shelf.hbs
  • Partials import
<Header class="partial">{{> Header}}</Header>

๐Ÿ“š References

BEM

Sass

Handlebars

Can I Email

Emails Support

Vtex Templates

Vtex Message Center