https://github.com/rinja-rs/rinja
A template rendering engine based on Jinja, generating type-safe Rust code at compile time.
https://github.com/rinja-rs/rinja
html jinja rust template-engine
Last synced: 4 months ago
JSON representation
A template rendering engine based on Jinja, generating type-safe Rust code at compile time.
- Host: GitHub
- URL: https://github.com/rinja-rs/rinja
- Owner: rinja-rs
- License: apache-2.0
- Created: 2024-06-17T13:42:32.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-20T15:33:29.000Z (9 months ago)
- Last Synced: 2024-10-20T17:45:53.279Z (9 months ago)
- Topics: html, jinja, rust, template-engine
- Language: Rust
- Homepage: https://rinja.readthedocs.io
- Size: 2.36 MB
- Stars: 125
- Watchers: 6
- Forks: 9
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# rinja
[](https://crates.io/crates/rinja)
[](https://github.com/rinja-rs/rinja/actions/workflows/rust.yml)
[](https://rinja.readthedocs.io/)
[](https://docs.rs/rinja/)
**Rinja** implements a template rendering engine based on [Jinja](https://jinja.palletsprojects.com/),
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](https://crates.io/crates/askama), please have a look at our
[blog post](https://blog.guillaume-gomez.fr/articles/2024-07-31+docs.rs+switching+jinja+template+framework+from+tera+to+rinja)
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][issues].
You can find the documentation about our syntax, features, configuration in our book:
[rinja.readthedocs.io](https://rinja.readthedocs.io/).
Have a look at our [*Rinja Playground*](https://rinja-rs.github.io/play-rinja/),
if you want to try out rinja's code generation online.
### 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
* Debugging features to assist you in template development
* Templates must be valid UTF-8 and produce UTF-8 when rendered
* 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
[issues]: https://github.com/rinja-rs/rinja/issues
How to get started
------------------
First, add the rinja dependency to your crate's `Cargo.toml`:
```sh
cargo add rinja
```
Now create a directory called `templates` in your crate root.
In it, create a file called `hello.html`, containing the following:
```jinja
Hello, {{ name }}!
```
In any Rust file inside your crate, add the following:
```rust
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.