Rocket/contrib/dyn_templates
Sergio Benitez 735bd99549 Update 'normpath' to 0.3. 2021-05-29 15:33:15 -07:00
..
src Remove 'default-features' from contrib examples. 2021-05-25 05:28:58 -07:00
tests Split 'rocket_contrib' into distinct crates. 2021-05-24 22:57:51 -07:00
Cargo.toml Update 'normpath' to 0.3. 2021-05-29 15:33:15 -07:00
README.md Remove 'default-features' from contrib examples. 2021-05-25 05:28:58 -07:00

README.md

dyn_templates ci.svg crates.io docs.svg

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

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

    [dependencies.rocket_dyn_templates]
    version = "0.1.0-dev"
    features = ["handlebars", "tera"]
    
  2. Write your template files in Handlebars (.hbs) and/or Tera (.tera) in the configurable template_dir directory (default: {rocket_root}/templates).

  3. 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;
    
    #[launch]
    fn rocket() -> _ {
        rocket::build().attach(Template::fairing())
    }
    
    #[get("/")]
    fn index() -> Template {
        Template::render("template-name", &context)
    }
    

See the crate docs for full details.