Build process

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:

Environment config

A global configuration object is computed by merging your Environment config on top of the base config.js.

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 config.js.

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.

Clean destination

The destination directories that you have defined under destination.path in your environment config are deleted.

Copy sources

All of your source Templates are copied over to the destination.path directories.

This is done so that we can then process the files in-place, which makes it easier to preserve your directory structure.

beforeCreate()

The beforeCreate event (CLI-only) is triggered, giving you access to the config before Maizzle loops over your Templates to compile them.

Compile templates

Each Template is parsed and compiled in-place, in your destination directory:

  1. Maizzle reads the Template file

  2. It extracts its Front Matter

  3. A unique Template config is computed by merging the Template's Front Matter keys with the Environment config

  4. beforeRender event is triggered

  5. PostHTML renders the template string

    Your Environment name, the compiled Tailwind CSS, and all config options (including any you defined in Front Matter) are exposed to all your templating parts as PostHTML expressions that you can use, under the page object.

  6. afterRender event is triggered

  7. 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 <head> and <body> CSS classes are replaced with email-safe alternatives
  • filters are applied to the HTML. For example, <style postcss|tailwindcss> tags are compiled with PostCSS/Tailwind CSS. posthtml-content is used to transform content marked with those custom attributes.
  • Markdown is compiled with posthtml-markdownit
  • prevent-widows looks for tags containing the prevent-widows attribute. When it finds one, it will replace the last space in your text with a &nbsp;.
  • attributeToStyle translates HTML attributes to inline CSS
  • CSS is inlined with Juice
  • Longhand CSS in style attributes is converted to shorthand-form
  • Unused CSS is removed with email-comb
  • Attributes are removed based on your config. By default, Maizzle cleans up any empty style="" and class="" attributes.
  • Inline CSS sizes are removed (width="" and height="" are preserved)
  • Inline background colors are removed (bgcolor="" is preserved)
  • Any extra attributes defined are added to tags
  • baseURL is prepended to configured tags
  • urlParameters are added to links
  • Ensure six digit HEX color codes are used in bgcolor and color attributes
  • Code is prettified/indented for humans, with pretty
  • Code is minified with html-crush
  • Strings are replaced based on your replaceStrings definitions
  1. afterTransformers event is triggered

  2. The compiled email template is saved at the configured location, with the configured extension.

    9.1 A plaintext version is output at the same location and with the same name, if plaintext is set to true

  3. Your assets are copied to the destination folder. All files and folders in templates.assets.source are copied to templates.assets.destination

afterBuild()

The afterBuild event is triggered (CLI-only).


Copyright © 2022 Maizzle Edit this page on GitHub