mjml

What is mjml?

MJML is a markup language designed to reduce the pain of coding responsive emails. It abstracts away the complexity of responsive design by providing a simple syntax that translates into responsive HTML.

What are mjml's main functionalities?

Responsive Email Design

MJML allows you to create responsive email designs easily. The above code creates a simple responsive email with a 'Hello World' text.

<mjml>
  <mj-body>
    <mj-section>
      <mj-column>
        <mj-text>Hello World</mj-text>
      </mj-column>
    </mj-section>
  </mj-body>
</mjml>

Custom Components

MJML provides a variety of built-in components like buttons, images, and text blocks. The above code demonstrates how to create a button that links to a URL.

<mjml>
  <mj-body>
    <mj-section>
      <mj-column>
        <mj-button href="https://www.example.com">Click Me</mj-button>
      </mj-column>
    </mj-section>
  </mj-body>
</mjml>

Conditional Rendering

MJML supports conditional rendering for different email clients. The above code shows how to include content specifically for Microsoft Outlook.

<mjml>
  <mj-body>
    <mj-raw>
      <!--[if mso]>
      <mj-section>
        <mj-column>
          <mj-text>Microsoft Outlook specific content</mj-text>
        </mj-column>
      </mj-section>
      <![endif]-->
    </mj-raw>
  </mj-body>
</mjml>

Other packages similar to mjml

handlebars

Handlebars is a popular templating engine that can be used to create dynamic HTML content, including emails. Unlike MJML, Handlebars does not provide built-in responsive design features, so you would need to handle the CSS and media queries yourself.

pug

Pug (formerly Jade) is another templating engine that can be used to generate HTML. While it is powerful and flexible, it does not offer the same level of abstraction for responsive email design as MJML does.

nunjucks

Nunjucks is a templating engine inspired by Jinja2. It is highly extensible and can be used to generate HTML for emails. However, like Handlebars and Pug, it does not provide built-in support for responsive email design.

README

| Introduction | Installation | Usage | Contribute |

---

Introduction

MJML is a markup language designed to reduce the pain of coding a responsive email. Its semantic syntax makes it easy and straightforward while its rich standard components library fastens your development time and lightens your email codebase. MJML’s open-source engine takes care of translating the MJML you wrote into responsive HTML.

Installation

Via NPM:

npm install -g mjml

Via... click:

Show me the code!

Command line

Compile the file and output the result in a.html

$> mjml -r input.mjml

Redirect the result to a file

$> mjml -r input.mjml -o output.html

Watch a file and compile every time the file changes

$> mjml -w input.mjml -o output.html

### Inside NodeJs

import mjml from 'mjml'

/*
  Compile an mjml string
*/
const htmlOutput = mjml.mjml2html(`<mj-body>
  <mj-section>
    <mj-column>
      <mj-text>
        Hello World!
      </mj-text>
    </mj-column>
  </mj-section>
</mj-body>
`)

/*
  Print the responsive HTML generated
*/
console.log(htmlOutput);

Create your component

Issue the following in your terminal

$> mjml --init-component <name of your component>

# If your component cannot contain anything else than text:
$> mjml --init-component <name of you component> -e

# It means nothing inside it will be parsed by the mjml engine.

It will create a basic component template in a .js file. Follow the instructions provided in the file and read more about custom components in the documentation

Try it live

Get your hands dirty by trying the MJML online editor! Write awesome code on the left side and preview your email on the right. You can also get the rendered HTML directly from the online editor.

Contributors

Maxime	Robin	Loeck	Guillaume	Meriadec	Arnaud	HTeuMeuLeu

Contribute

• Fork the repository
• Code an awesome feature (we are confident about that)
• Make your pull request
• Add your github profile here