This is a forked version of the original https://github.com/mjmlio/mjml which can be run on both Node.js and a web browser. It has the following known limitations:
- Does not support features that require Node.js API, such as file reading.
- Does not support features involving the
.mjmlconfigfile, such as community/custom components. - Does not support
options.skeleton,options.minifyandoptions.beautify. - Does not support
mj-includetags. - Does not have backward compatibility with MJML 3.
If you're looking for MJML 3.3.X check this branch
| Translated documentation | Introduction | Installation | Usage |
| Language | Link for documentation |
|---|---|
| 日本語 | 日本語ドキュメント |
MJML is a markup language created by Mailjet and 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 the MJML you wrote into responsive HTML.
You can install MJML with NPM to use it with NodeJS or a web browser. If you're not sure what those are, head over to Usage for other ways to use MJML.
npm install mjmlTo work on MJML, make changes and create merge requests, download and install yarn for easy development.
git clone https://github.com/mjmlio/mjml.git && cd mjml
yarn
yarn buildYou can also run yarn build:watch to rebuild the package as you code.
Don't want to install anything? Use the free online editor!
MJML comes with an ecosystem of tools and plugins, check out:
- The MJML App (MJML is included)
- Visual Studio Code plugin (MJML is included)
- Atom plugin (MJML needs to be installed separately)
- Sublime Text plugin (MJML needs to be installed separately)
For more tools, check the Community page.
import mjml2html from 'mjml'
/*
Compile an mjml string
*/
const htmlOutput = 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 optional options as an object to the mjml2html function:
| option | unit | description | default value |
|---|---|---|---|
| fonts | object | Default fonts imported in the HTML rendered by MJML | See in index.js |
| keepComments | boolean | Option to keep comments in the HTML output | true |
| validationLevel | string | Available values for the validator: '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, see mjml-cli documentation for more info | NA |
A free-to-use MJML API is available to make it easy to integrate MJML in your application. Head over here to learn more about the API.
MJML wouldn't be as cool without its amazing community. Head over the Community Slack to meet fellow MJML'ers.