MJML2HTML

Simple API to convert MJML content to HTML on the fly.

Requirements

Git
Docker
Docker-compose

Getting started

To set-up the project, run the following command:

docker-compose up

Once the Docker is running, you can use your API endpoint under localhost:3001.

Usage

This project exposes a POST endpoint under /. To make it work, you must send a text/plain body with your MJML content. When received, the server converts your MJML into an HTML string and returns the content as text/html.

Example

curl --header "Content-Type: text/plain" \
  --request POST \
  --data '<mjml><mj-body><mj-text>Hello!</mj-text></mj-body></mjml>' \
  http://localhost:3001/

May return:

<!doctype html>
    <html xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
      <!-- Head (croped for demo)... -->
      <body>
      <div
         style=""
      >
      <div
         style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1;text-align:left;color:#000000;"
      >
        Hello!
      </div>
      </div>
      </body>
    </html>

API

To use the API params, you can pass them as query parameters localhost:3001/?comments=false&minfiy=true.

Param	Type	Default	Possible values
comments	Boolean	false
minify	Boolean	false
beautify	Boolean	false
validation	String	strict	skip, soft, strict

License

This project is licensed under MIT License