diff options
Diffstat (limited to 'vendor/askama/README.md')
| -rw-r--r-- | vendor/askama/README.md | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/vendor/askama/README.md b/vendor/askama/README.md new file mode 100644 index 000000000..9055004f0 --- /dev/null +++ b/vendor/askama/README.md @@ -0,0 +1,96 @@ +# Askama + +[](https://docs.rs/askama/) +[](https://crates.io/crates/askama) +[](https://github.com/djc/askama/actions?query=workflow%3ACI) +[](https://gitter.im/djc/askama) + +Askama implements a template rendering engine based on [Jinja](https://jinja.palletsprojects.com/). +It generates 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, or read [the book][docs]. + +**"Pretty exciting. I would love to use this already."** -- +[Armin Ronacher][mitsuhiko], creator of Jinja + +All feedback welcome. Feel free to file bugs, requests for documentation and +any other feedback to the [issue tracker][issues] or [tweet me][twitter]. + +Askama was created by and is maintained by Dirkjan Ochtman. If you are in a +position to support ongoing maintenance and further development or use it +in a for-profit context, please consider supporting my open source work on +[Patreon][patreon]. + +### 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][benchmarks] +* Optional built-in support for Actix, Axum, Gotham, Mendes, Rocket, tide, and warp web frameworks +* Debugging features to assist you in template development +* Templates must be valid UTF-8 and produce UTF-8 when rendered +* IDE support available in [JetBrains products](https://plugins.jetbrains.com/plugin/16591-askama-template-support) +* 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 + +[docs]: https://djc.github.io/askama/ +[fafhrd91]: https://github.com/fafhrd91 +[mitsuhiko]: http://lucumr.pocoo.org/ +[issues]: https://github.com/djc/askama/issues +[twitter]: https://twitter.com/djco/ +[patreon]: https://www.patreon.com/dochtman +[benchmarks]: https://github.com/djc/template-benchmarks-rs + + +How to get started +------------------ + +First, add the following to your crate's `Cargo.toml`: + +```toml +# in section [dependencies] +askama = "0.11.2" + +``` + +Now create a directory called `templates` in your crate root. +In it, create a file called `hello.html`, containing the following: + +``` +Hello, {{ name }}! +``` + +In any Rust file inside your crate, add the following: + +```rust +use askama::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. + +Review the [test cases] for more examples. + +[test cases]: https://github.com/djc/askama/tree/main/testing |