Crate mrml

This project is a reimplementation of the nice MJML markup language in Rust.

To use it you can simply update your Cargo.toml by adding

[dependencies]
mrml = "1.2"
serde = { version = "1.0", features = ["derive"] }

And you can then just create a main.rs with the following code

let root = mrml::parse("<mjml><mj-body></mj-body></mjml>").expect("parse template");
let opts = mrml::prelude::render::Options::default();
match root.render(&opts) {
    Ok(content) => println!("{}", content),
    Err(_) => println!("couldn't render mjml template"),
};

You can also use the mj-include component by specifying a loader.

use mrml::prelude::parser::ParserOptions;
use mrml::prelude::parser::memory_loader::MemoryIncludeLoader;

let loader = MemoryIncludeLoader::from(vec![("partial.mjml", "<mj-button>Hello</mj-button>")]);
let options = ParserOptions {
    include_loader: Box::new(loader),
};
match mrml::parse_with_options("<mjml><mj-head /><mj-body><mj-include path=\"partial.mjml\" /></mj-body></mjml>", &options) {
    Ok(_) => println!("Success!"),
    Err(err) => eprintln!("Something went wrong: {err:?}"),
}

Why?

A Node.js server rendering an MJML template takes around 20 MB of RAM at startup and 130 MB under stress test. In Rust, less than 1.7 MB at startup and a bit less that 3 MB under stress test. The Rust version can also handle twice as many requests per second. You can perform the benchmarks by running bash script/run-bench.sh.

Also, the JavaScript implementation cannot be run in the browser; the Rust one (and WebAssembly one) can be.

Modules

• comment
• mj_accordion
  Module containing the mj-accordion element as defined in the documentation.
• mj_accordion_element
• mj_accordion_text
• mj_accordion_title
• mj_attributes
• mj_attributes_all
• mj_attributes_class
• mj_attributes_element
• mj_body
• mj_breakpoint
• mj_button
• mj_carousel
• mj_carousel_image
• mj_column
• mj_divider
• mj_font
• mj_group
• mj_head
• mj_hero
• mj_image
• mj_include
• mj_navbar
• mj_navbar_link
• mj_preview
• mj_raw
• mj_section
• mj_social
• mj_social_element
• mj_spacer
• mj_style
• mj_table
• mj_text
• mj_title
• mj_wrapper
• mjml
• node
• prelude
• text

Macros

• print_display

Functions

• parse
  Function to parse a raw mjml template using the default parsing options.
• parse_with_options
  Function to parse a raw mjml template with some parsing options. This function is just an alias to the Mjml::parse_with_options function.