defmodule Mjml do
@moduledoc """
Provides functions for transpiling MJML email templates to HTML.
"""
@doc """
Converts an MJML string to HTML content.
Returns a result tuple:
* `{:ok, html}` for a successful MJML transpiling
* `{:error, message}` for a failed MJML transpiling
You can pass render options to customize the rendering of the final HTML:
* `keep_comments` – when `false`, removes the comments from the rendered HTML.
Defaults to `true`.
* `social_icon_path` – when given, uses this base path to generate social icon URLs.
E.g. `social_icon_path: "https://example.com/icons/"` will generate a social icon
URL, like "https://example.com/icons/github.png"
## Examples
iex> Mjml.to_html("")
{:ok, " Mjml.to_html("something not MJML")
{:error, "Couldn't convert MJML template"}
iex> opts = [keep_comments: false, social_icon_path: "https://example.com/icons/"]
iex> Mjml.to_html("", opts)
{:ok, "