flair/README.md
2023-01-11 18:12:52 +01:00

47 lines
822 B
Markdown

# <p align="center">Flair</p>
An extra simplified version of Jinja, written as a Rust lib.
## 🧐 Features
- Reads templates
- Dynamically generate content based on rust variables or bash commands
# Templates ?
Templates are defined as .ft files.
They may contain any text. Special words are defined between percentage signs:
```
Hello %%name%%
Today is the %%cmd: date%%
```
## Try
An example website is included, that uses a template for its index.html.
To see it, clone this repo, then:
```bash
cargo run
```
Next, go to http://localhost:8080
## Use
Add this to your Cargo.toml
```bash
flair = { git = "https://gitea.squi.fr/Rust/flair.git" }
```
## Doc
Clone this repo, then compile and open the doc:
```bash
cargo doc --open
```
## 🙇 Author
Justine Pelletreau
## ➤ License
Distributed as is.