Transactional email templates documentation

Compiled files

The quickest way to get started is with templates from the dist folder.

Templates inside this folder are ready to use, so you can simply copy/paste the HTML code into your ESP. Of course, you may edit the text and image paths for any of these templates, in your favorite code editor.

Maizzle project

If you'd like to use Maizzle and Tailwind CSS to further customize the emails, you'll need to follow some extra steps.

1. First, make sure you have Node.js installed - this will also install NPM, which offers commands that we'll need, like npm install.

   Once you have Node.js and NPM installed, open a Terminal and run this command:

   npm install -g @maizzle/cli

   This installs the Maizzle CLI tool, which lets you run commands like maizzle serve for local development, or maizzle build shopify for building production-ready Shopify emails.

2. Next, make sure that you're inside the project directory.

   For example, the project directory is responsive-email-templates-1.0:

   # cd into the project directory

   cd responsive-email-templates-1.0

   You'll know you're in the right folder if you run the ls command next, and see the package.json file name listed in the output, among others.

3. Inside this directory, run the following command to install Maizzle's dependencies:

   npm install

Once it finishes, you're ready to use Maizzle to customize and build the emails.

Build commands

For local development, with live browser preview:

Production

The following commands will build production-ready emails, as defined in their corresponding config.[environment].js file (read more about config environments in Maizzle).

Tailwind CSS

The Maizzle project comes with a custom tailwind.config.js that defines utility classes based on the design system. This file also configures Tailwind for better email client support - read more about Maizzle's Tailwind CSS config.