History

Sergio Benitez 02011a1307 Clean up codebase: fix reasonable clippy warnings. This commit is a codebase-wide cleanup driven by clippy warnings. In addition to fixing every reasonable warning, the following new functionality was introduced: * `Accept::new()` now takes any `T: Into<QMediaType>` iterator. * `TempFile::is_empty()` was added. * `HeaderMap` now implements `IntoIterator`. This commit makes the following breaking changes: * The `IntoCollection` trait is gone. Generics previously bound by the trait are now bound by `IntoIterator`. This affects: - `Accept::new()` - `ContentType::with_params()` - `Permission::{allow, allowed}()` * `MediaType`, `QMediaType`, and `Allow` implement `IntoIterator`, enabling most existing code to continue working without change. * The inherent `HeaderMap::into_iter()` method was removed. * The `Ok` variant in ErrorKind::Liftoff` is now `Box<Rocket<Orbit>>`.		2024-03-20 00:47:38 -07:00
..
src	Clean up codebase: fix reasonable clippy warnings.	2024-03-20 00:47:38 -07:00
tests	Avoid using 'glob' to walk templates directory.	2023-10-14 15:00:36 -07:00
Cargo.toml	Clean up codebase: fix reasonable clippy warnings.	2024-03-20 00:47:38 -07:00
README.md	Update handlebars version in dyn_templates docs.	2024-01-17 21:41:25 -08: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"
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.