MJML 4

If you're looking for MJML 3.3.X checkthis branch

|Translated documentation |Introduction |Installation |Usage|

---

Translated documentation

Language	Link for documentation
Nhật Bản ngữ	Nhật Bản ngữ ドキュメント

Introduction

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

Installation

You can installMJMLwithNPMto use it with NodeJS or the Command Line Interface. If you're not sure what those are, head over toUsagefor other ways to use MJML.

npm install mjml

Development

To work on MJML, make changes and create merge requests, download and installyarnfor easy development.

git clone https://github /mjmlio/mjml.git&&cdmjml
yarn
yarn build

You can also runyarn build:watchto rebuild the package as you code.

Usage

Online

Don't want to install anything? Use the free online editor!

Applications and plugins

MJML comes with an ecosystem of tools and plugins, check out:

• TheMJML App(MJML is included)
• Visual Studio Code plugin(MJML is included)
• Sublime Text plugin(MJML needs to be installed separately)

For more tools, check theCommunitypage.

Command line interface

Compiles the file and outputs the HTML generated inoutput.html

mjml input.mjml -o output.html

You can pass optionalargumentsto the CLI and combine them.

argument	description	default value
mjml -m [input]	Migrates a v3 MJML file to the v4 syntax	NA
mjml [input] -o [output]	Writes the output to [output]	NA
mjml [input] -s	Writes the output tostdout	NA
mjml -w [input]	Watches the changes made to[input](file or folder)	NA
mjml [input] --config.beautify	Beautifies the output (trueorfalse)	true
mjml [input] --config.minify	Minifies the output (trueorfalse)	false

Seemjml-cli documentationfor more information about config options.

Inside Node.js

importmjml2htmlfrom'mjml'

/*
Compile an mjml string
*/
consthtmlOutput=mjml2html(`
<mjml>
<mj-body>
<mj-section>
<mj-column>
<mj-text>
Hello World!
</mj-text>
</mj-column>
</mj-section>
</mj-body>
</mjml>
`,options)


/*
Print the responsive HTML generated and MJML errors if any
*/
console.log(htmlOutput)

You can pass optionaloptionsas an object to themjml2htmlfunction:

option	unit	description	default value
fonts	object	Default fonts imported in the HTML rendered by MJML	See inindex.js
keepComments	boolean	Option to keep comments in the HTML output	true
ignoreIncludes	boolean	Option to ignore mj-includes	false
beautify	boolean	Option to beautify the HTML output	false
minify	boolean	Option to minify the HTML output	false
validationLevel	string	Available values for thevalidator:'strict', 'soft', 'skip'	'soft'
filePath	string	Path of file, used for relative paths in mj-includes	'.'
preprocessors	array of functions	Preprocessors applied to the xml before parsing. Input must be xml, not json. Functions must be (xml: string) => string	[]
juicePreserveTags	Preserve some tags when inlining css, seemjml-cli documentationfor more info	NA
minifyOptions	Options for html minifier, seemjml-cli documentationfor more info	NA
mjmlConfigPath	string	The path or directory of the.mjmlconfigfile (for custom components use)	process.cwd()
useMjmlConfigOptions	Allows to use theoptionsattribute from.mjmlconfigfile	false

Client-side (in browser)

varmjml2html=require('mjml-browser')

/*
Compile a mjml string
*/
varhtmlOutput=mjml2html(`
<mjml>
<mj-body>
<mj-section>
<mj-column>
<mj-text>
Hello World!
</mj-text>
</mj-column>
</mj-section>
</mj-body>
</mjml>
`,options)


/*
Print the responsive HTML generated and MJML errors if any
*/
console.log(htmlOutput)

API

A free-to-use MJML API is available to make it easy to integrate MJML in your application. Head overhereto learn more about the API.

MJML Slack

MJML wouldn't be as cool without its amazing community. Head over theCommunity Slackto meet fellow MJML'ers.

Contributors

• Maxime
• Nicolas
• Cedric
• Loeck
• Robin
• Guillaume
• Meriadec
• Arnaud
• HTeuMeuLeu
• Emmanuel Payet
• Matthieu
• Rogier