History

Sergio Benitez ed5c755bb6 Avoid using 'glob' to walk templates directory. Previously, `dyn_templates` walked the user-provided `template_dir` path by constructing a glob pattern prefixed with `template_dir`. If `template_dir` contained characters recognized by the glob pattern parser, then at best the pattern failed to parse, and at worst, incorrect directories were searched. This commit removes the use of `glob` to walk the templates directory and instead uses `walkdir`, obviating the issues described above. Fixes #2627.		2023-10-14 15:00:36 -07:00
..
src	Avoid using 'glob' to walk templates directory.	2023-10-14 15:00:36 -07:00
tests	Avoid using 'glob' to walk templates directory.	2023-10-14 15:00:36 -07:00
Cargo.toml	Avoid using 'glob' to walk templates directory.	2023-10-14 15:00:36 -07: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.