Skip to content

Commit e2a2c23

Browse files
authored
Merge pull request #10 from Kijewski/pr-rtd-link
Add link to our book in README.md
2 parents aca92c3 + 32ee14f commit e2a2c23

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ See below for an example.
88
All feedback welcome. Feel free to file bugs, requests for documentation and
99
any other feedback to the [issue tracker][issues].
1010

11+
You can find the documentation about our syntax, features, configuration in our book:
12+
[rinja.readthedocs.io](https://rinja.readthedocs.io/en/latest/).
13+
1114
### Feature highlights
1215

1316
* Construct templates using a familiar, easy-to-use syntax
@@ -44,7 +47,7 @@ cargo add rinja
4447
Now create a directory called `templates` in your crate root.
4548
In it, create a file called `hello.html`, containing the following:
4649

47-
```
50+
```jinja
4851
Hello, {{ name }}!
4952
```
5053

rinja/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description = "Type-safe, compiled Jinja-like templates for Rust"
55
documentation = "https://docs.rs/rinja"
66
keywords = ["markup", "template", "jinja2", "html"]
77
categories = ["template-engine"]
8-
homepage = "https://github.com/rinja-rs/rinja"
8+
homepage = "https://rinja.readthedocs.io/"
99
repository = "https://github.com/rinja-rs/rinja"
1010
license = "MIT OR Apache-2.0"
1111
workspace = ".."

rinja/src/lib.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
//! in [`rinja_derive`](https://crates.io/crates/rinja_derive)).
66
//!
77
//! For feature highlights and a quick start, please review the
8-
//! [README](https://github.com/rinja-rs/rinja/blob/main/README.md).
8+
//! [README](https://github.com/rinja-rs/rinja/blob/master/README.md).
9+
//!
10+
//! You can find the documentation about our syntax, features, configuration in our book:
11+
//! [rinja.readthedocs.io](https://rinja.readthedocs.io/en/latest/).
912
//!
1013
//! # Creating Rinja templates
1114
//!

0 commit comments

Comments
 (0)