Packages

mjml

0.1.0
6.0.0 5.3.1 5.3.0 5.2.0 5.1.1 5.1.0 5.0.0 4.0.0 3.1.0 3.0.3 3.0.2 3.0.1 3.0.0 2.0.0 1.5.0 1.4.0 1.3.5 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0 0.3.1 0.3.0 0.2.0 0.1.0

Responsive emails made easy. NIF bindings for the MJML Rust implementation (mrml)

HexDocs Report package

Current section

Files

Jump to
Documentation
License
32 Versions
1 Dependency
Dependants
Files
Activity
mjml README.md
Raw

README.md 

# MJML (Rust NIFs for Elixir)
[![Hex version badge](https://img.shields.io/hexpm/v/mjml.svg)](https://hex.pm/packages/mjml)
[![License badge](https://img.shields.io/hexpm/l/mjml.svg)](https://github.com/paulgoetze/mjml/blob/main/LICENSE.md)
Native Implemented Function (NIF) bindings for the [MJML](https://mjml.io) Rust implementation ([mrml](https://github.com/jdrouet/mrml)).
## Installation
The package can be installed by adding `mjml` to your list of dependencies in `mix.exs`:
```elixir
def deps do
  [
    {:mjml, "~> 0.1.0"}
  ]
end
```
## Usage
Transpile MJML templates to HTML with: 
```elixir
mjml = "<mjml>...</mjml>"
{:ok, html} = Mjml.to_html(mjml)
# For an invalid MJML template:
mjml = "something not MJML"
{:error, message} = Mjml.to_html(mjml)
```
## License
Copyright (c) 2020, Paul Götze
This software is licensed under the [MIT License](https://github.com/paulgoetze/mjml_nif/blob/main/LICENSE.md).