README.md

Askama

Askama implements a template rendering engine based on Jinja. It generates 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, or read the book.

"Pretty exciting. I would love to use this already." -- Armin Ronacher, creator of Jinja

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

Askama was created by and is maintained by Dirkjan Ochtman. If you are in a position to support ongoing maintenance and further development or use it in a for-profit context, please consider supporting my open source work on Patreon.

Feature highlights

• Construct templates using a familiar, easy-to-use syntax
• Benefit from the safety provided by Rust's type system
• Template code is compiled into your crate for optimal performance
• Optional built-in support for Actix, Axum, Rocket, and warp web frameworks
• Debugging features to assist you in template development
• Templates must be valid UTF-8 and produce UTF-8 when rendered
• IDE support available in JetBrains products
• Works on stable Rust

Supported in templates

• Template inheritance
• Loops, if/else statements and include support
• Macro support
• Variables (no mutability allowed)
• Some built-in filters, and the ability to use your own
• Whitespace suppressing with '-' markers
• Opt-out HTML escaping
• Syntax customization

How to get started

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

cargo add askama

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 askama::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.

Review the test cases for more examples.