Simple, small, and extremely fast template engine for Rust
[User Guide](https://rust-sailfish.github.io/sailfish/) | [API Docs](https://docs.rs/sailfish) | [Examples](./examples)
## ✨ Features
- Simple and intuitive syntax inspired by [EJS](https://ejs.co/)
- Include another template file inside template
- Built-in filters
- Minimal dependencies (<15 crates in total)
- Extremely fast (See [benchmarks](https://github.com/djc/template-benchmarks-rs))
- Better error message
- Syntax highlighting support ([vscode](./syntax/vscode), [vim](./syntax/vim))
- Works on Rust 1.60 or later
## 🐟 Example
Dependencies:
```toml
[dependencies]
sailfish = "0.9.0"
```
You can choose to use `TemplateSimple` to access fields directly:
> Template file (templates/hello.stpl):
>
> ```erb
>
>
> <% for msg in messages { %>
> <%= msg %>
> <% } %>
>
>
> ```
>
> Code:
>
> ```rust
> use sailfish::TemplateSimple;
>
> #[derive(TemplateSimple)]
> #[template(path = "hello.stpl")]
> struct HelloTemplate {
> messages: Vec
> }
>
> fn main() {
> let ctx = HelloTemplate {
> messages: vec![String::from("foo"), String::from("bar")],
> };
> println!("{}", ctx.render_once().unwrap());
> }
> ```
Or use the more powerful `Template/TemplateMut/TemplateOnce`:
> Template file (templates/hello.stpl):
>
> ```erb
>
>
> <% for msg in &self.messages { %>
> <%= msg %>
> <% } %>
> <%= self.say_hello() %>
>
>
> ```
>
> Code:
>
> ```rust
> use sailfish::Template;
>
> #[derive(Template)]
> #[template(path = "hello.stpl")]
> struct HelloTemplate {
> messages: Vec
> }
>
> impl HelloTemplate {
> fn say_hello(&self) -> String {
> String::from("Hello!")
> }
> }
>
> fn main() {
> let ctx = HelloTemplate {
> messages: vec![String::from("foo"), String::from("bar")],
> };
> println!("{}", ctx.render().unwrap());
> }
> ```
You can find more examples in [examples](./examples) directory.
## 🐾 Roadmap
- `Template` trait ([RFC](https://github.com/rust-sailfish/sailfish/issues/3))
- Template inheritance (block, partials, etc.)
## 👤 Author
🇯🇵 **Ryohei Machida**
* GitHub: [@Kogia-sima](https://github.com/Kogia-sima)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Since sailfish is an immature library, there are many [planned features](https://github.com/rust-sailfish/sailfish/labels/Type%3A%20RFC) that is on a stage of RFC. Please leave a comment if you have an idea about its design!
Also I welcome any pull requests to improve sailfish! Find issues with [Status: PR Welcome](https://github.com/rust-sailfish/sailfish/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+PR+Welcome%22) label, and [let's create a new pull request](https://github.com/rust-sailfish/sailfish/pulls)!
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Ryohei Machida](https://github.com/Kogia-sima).
This project is [MIT](https://github.com/rust-sailfish/sailfish/blob/master/LICENSE) licensed.
---
*This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)*