History

Sergio Benitez b6430e9970 Rename 'Outcome::Failure' to 'Outcome::Error'. The primary motivation is to deconflate the leading `F`s in `Failure` and `Forward`. In particular, when using a generics, we used `F` for forward, which could easily be confused for `F` for `Failure`. This resolves the conflation.		2023-11-01 18:50:55 -05:00
..
src	Rename 'Outcome::Failure' to 'Outcome::Error'.	2023-11-01 18:50:55 -05:00
tests	Avoid using 'glob' to walk templates directory.	2023-10-26 20:01:06 -05:00
Cargo.toml	Avoid using 'glob' to walk templates directory.	2023-10-26 20:01:06 -05:00
README.md	New version: 0.5.0-rc.3.	2023-03-23 16:56:17 -07:00

README.md

`dyn_templates`

This crate adds support for dynamic template rendering to Rocket. It automatically discovers templates, provides a Responder to render templates, and automatically reloads templates when compiled in debug mode. At present, it supports Handlebars and Tera.

Usage

Enable the rocket_dyn_templates feature corresponding to your templating engine(s) of choice:

[dependencies.rocket_dyn_templates]
version = "=0.1.0-rc.3"
features = ["handlebars", "tera"]

Write your template files in Handlebars (.hbs) and/or Tera (.tera) in the configurable template_dir directory (default: {rocket_root}/templates).

Attach Template::fairing() and return a Template using Template::render(), supplying the name of the template file minus the last two extensions:

use rocket_dyn_templates::{Template, context};

#[get("/")]
fn index() -> Template {
    Template::render("template-name", context! { field: "value" })
}

#[launch]
fn rocket() -> _ {
    rocket::build().attach(Template::fairing())
}

See the crate docs for full details.