Home

Awesome

rinja

Crates.io GitHub Workflow Status Book docs.rs

Rinja implements a template rendering engine based on Jinja, and generates type-safe Rust code from your templates at compile time based on a user-defined struct to hold the template's context. See below for an example. It is a fork of Askama, please have a look at our blog post highlighting differences between the two crates.

All feedback welcome! Feel free to file bugs, requests for documentation and any other feedback to the issue tracker.

You can find the documentation about our syntax, features, configuration in our book: rinja.readthedocs.io.

Have a look at our Rinja Playground, if you want to try out rinja's code generation online.

Feature highlights

Supported in templates

How to get started

First, add the rinja dependency to your crate's Cargo.toml:

cargo add rinja

Now create a directory called templates in your crate root. In it, create a file called hello.html, containing the following:

Hello, {{ name }}!

In any Rust file inside your crate, add the following:

use rinja::Template; // bring trait in scope

#[derive(Template)] // this will generate the code...
#[template(path = "hello.html")] // using the template in this path, relative
                                 // to the `templates` dir in the crate root
struct HelloTemplate<'a> { // the name of the struct can be anything
    name: &'a str, // the field name should match the variable name
                   // in your template
}

fn main() {
    let hello = HelloTemplate { name: "world" }; // instantiate your struct
    println!("{}", hello.render().unwrap()); // then render it.
}

You should now be able to compile and run this code.