Email templates documentation
This documentation is our email templates. It should cover everything from installing your project and preparing your code for production.
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.
Source code "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.
First, make sure you have Node.js installed - this will also install NPM, which offers commands that we’ll need, like
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 servefor local development, or
maizzle build shopifyfor building production-ready Shopify emails. Please note Shopify is only available for cetrain templates such as Essential: eCommerce.
Next, make sure that you’re inside the project directory.# cd into the project directory
cd folder name
You’ll know you’re in the right folder if you run the
lscommand next, and see the
package.jsonfile name listed in the output, among others.
Inside this directory, run the following command to install Maizzle’s dependencies:
Once it finishes, you’re ready to use Maizzle to customize and build the emails.
For local development, with live browser preview:
The following commands will build production-ready emails, as defined in their corresponding
config.[environment].js file (read more about config environments in Maizzle).
maizzle build production
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.
- ✓Outlook iOS
- ✓Gmail iOS
- ✓Gmail Android
- ✓Samsung Mail
- ✓Apple Mail
- ✓Outlook 2013
- ✓Outlook 2016
- ✓Outlook 2019
- ✓Office 365