When you run
maizzle build, your templates go through a series of events that compile them to plain HTML and apply various, email-specific transformations.
To get a better understanding of how Maizzle builds your emails, here's a step-by-step guide of what's going on under the hood:
A global configuration object is computed by merging your environment config on top of the base
For example, running
maizzle build production will tell Maizzle to look for
config.production.js at your current location, and merge it on top of
Otherwise, if you're simply running the
maizzle build or
maizzle serve commands, only the base
config.js will be used.
Compile Tailwind CSS
Tailwind CSS is compiled, and various PostCSS plugins are enabled depending on the build environment and your config.
When you specify a build environment, i.e.
maizzle build production, PurgeCSS removes any unused classes from the compiled CSS. It scans all your source folders and any other, custom sources that you specify, and removes any unused CSS from the compiled CSS that will be passed to the final template.
email-combcan also remove unused CSS. But in order to speed things up it's best to feed it as little CSS as possible.
The destination directory that you have defined under
build.destination.path in your environment config is deleted.
Your source Templates are copied over to the
This is done so that we can then process the files in-place, which makes it easier to preserve your directory structure.
beforeCreate event (CLI-only) is triggered, giving you access to the config before Maizzle loops over your Templates to compile them.
Each Template is parsed and compiled in-place, in your destination directory:
Maizzle reads the Template file
It extracts its Front Matter
A unique Template
configis computed by merging the Template's Front Matter keys with the Environment
beforeRenderevent is triggered
PostHTML renders the template string
Your Environment name, the compiled Tailwind CSS, and all
configoptions (including any you defined in Front Matter) are exposed to all your templating parts as PostHTML expressions that you can use, under the
afterRenderevent is triggered
The compiled HTML is now passed on to a series of Transformers.
The order of events is exactly as follows, and they all happen (or not) depending on how you've configured them in your Environment config or in the Template's Front Matter:
- escaped characters in
<body>CSS classes are replaced with email-safe alternatives
- posthtml-content is used to transform content marked with custom attributes. By default, it looks for any
<style postcss>tag in the Template. If it finds any, it tries to compile the contents with PostCSS. Useful if you need to use Tailwind CSS inside a style block right in your Template.
- posthtml-md2html is used to compile Markdown
- prevent-widows looks for tags containing the
prevent-widowsattribute. When it finds one, it will replace the last space in your text with a
- Juice inlines CSS
- email-comb removes any unused CSS
- attributes are removed based on your config. By default, Maizzle cleans up any empty
- inline CSS sizes are removed (
- inline background colors are removed (
- any extra attributes defined are added to tags
baseImageURLis prepended to both inline and background image paths
urlParametersare added to links
- ensure six digit HEX color codes (see package)
- pretty is used to prettify your code
- html-crush minifies your email code
- strings are replaced based on your
- escaped characters in
afterTransformersevent is triggered
9.1 A plaintext version is output at the same location and with the same name, if
plaintextis set to
Your assets are copied to the destination folder. All files and folders in
build.assets.sourceare copied to
afterBuild event is triggered (CLI-only).