# mjml
**Repository Path**: mirrors_FGRibreau/mjml
## Basic Information
- **Project Name**: mjml
- **Description**: MJML: the only framework that makes responsive-email easy
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-17
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## 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
### Requirements
- Node >= 4.2.x
Via NPM:
```bash
npm install -g mjml
```
Via... click:
# Show me the code!
### Command line
> Compiles the file and outputs the result in `a.html`
```bash
$> mjml -r input.mjml
```
> Redirects the result to a file
```bash
$> mjml -r input.mjml -o output.html
```
> Watches a file and compiles every time the file changes
```bash
$> mjml -w input.mjml -o output.html
```
### Inside Node.js
```javascript
import { mjml2html } from 'mjml'
/*
Compile an mjml string
*/
const htmlOutput = mjml2html(`
Hello World!
`)
/*
Print the responsive HTML generated
*/
console.log(htmlOutput)
```
### Create your component
> Issue the following in your terminal
```bash
$> mjml --init-component
# If your component cannot contain anything else than text:
$> mjml --init-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
# Contribute
- [ ] Fork the repository
- [x] Code an awesome feature (we are confident about that)
- [ ] Make your pull request
- [ ] Add your github profile here 
