Add link to our book in README.md

This commit is contained in:
René Kijewski 2024-06-18 14:16:00 +02:00
parent aca92c3258
commit 32ee14f875
3 changed files with 9 additions and 3 deletions

View File

@ -8,6 +8,9 @@ See below for an example.
All feedback welcome. Feel free to file bugs, requests for documentation and All feedback welcome. Feel free to file bugs, requests for documentation and
any other feedback to the [issue tracker][issues]. any other feedback to the [issue tracker][issues].
You can find the documentation about our syntax, features, configuration in our book:
[rinja.readthedocs.io](https://rinja.readthedocs.io/en/latest/).
### Feature highlights ### Feature highlights
* Construct templates using a familiar, easy-to-use syntax * Construct templates using a familiar, easy-to-use syntax
@ -44,7 +47,7 @@ cargo add rinja
Now create a directory called `templates` in your crate root. Now create a directory called `templates` in your crate root.
In it, create a file called `hello.html`, containing the following: In it, create a file called `hello.html`, containing the following:
``` ```jinja
Hello, {{ name }}! Hello, {{ name }}!
``` ```

View File

@ -5,7 +5,7 @@ description = "Type-safe, compiled Jinja-like templates for Rust"
documentation = "https://docs.rs/rinja" documentation = "https://docs.rs/rinja"
keywords = ["markup", "template", "jinja2", "html"] keywords = ["markup", "template", "jinja2", "html"]
categories = ["template-engine"] categories = ["template-engine"]
homepage = "https://github.com/rinja-rs/rinja" homepage = "https://rinja.readthedocs.io/"
repository = "https://github.com/rinja-rs/rinja" repository = "https://github.com/rinja-rs/rinja"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
workspace = ".." workspace = ".."

View File

@ -5,7 +5,10 @@
//! in [`rinja_derive`](https://crates.io/crates/rinja_derive)). //! in [`rinja_derive`](https://crates.io/crates/rinja_derive)).
//! //!
//! For feature highlights and a quick start, please review the //! For feature highlights and a quick start, please review the
//! [README](https://github.com/rinja-rs/rinja/blob/main/README.md). //! [README](https://github.com/rinja-rs/rinja/blob/master/README.md).
//!
//! You can find the documentation about our syntax, features, configuration in our book:
//! [rinja.readthedocs.io](https://rinja.readthedocs.io/en/latest/).
//! //!
//! # Creating Rinja templates //! # Creating Rinja templates
//! //!