Simple, small, and extremely fast template engine for Rust
[](https://github.com/rust-sailfish/sailfish/actions?query=workflow%3ATests)
[](https://crates.io/crates/sailfish)
[](https://deps.rs/repo/github/rust-sailfish/sailfish)
[](https://blog.rust-lang.org/2022/04/07/Rust-1.60.0.html)
[](https://github.com/rust-sailfish/sailfish/blob/master/LICENSE)
[User Guide](https://rust-sailfish.github.io/sailfish/) | [API Docs](https://docs.rs/sailfish) | [Examples](./examples)
✨ Features
- Simple and intuitive syntax inspired by EJS
- Include another template file inside template
- Built-in filters
- Minimal dependencies (<15 crates in total)
- Extremely fast (See benchmarks)
- Better error message
- Syntax highlighting support (vscode, vim)
- Works on Rust 1.60 or later
🐟 Example
Dependencies:
toml
[dependencies]
sailfish = "0.7.0"
Template file (templates/hello.stpl):
erb
<html>
<body>
<% for msg in &messages { %>
<div><%= msg %></div>
<% } %>
</body>
</html>
Code:
```rust
use sailfish::TemplateOnce;
[derive(TemplateOnce)]
[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());
}
```
You can find more examples in examples directory.
🐾 Roadmap
Template trait (RFC)- Template inheritance (block, partials, etc.)
👤 Author
🇯🇵 Ryohei Machida
🤝 Contributing
Contributions, issues and feature requests are welcome!
Since sailfish is an immature library, there are many planned features 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 label, and let's create a new pull request!
Show your support
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2020 Ryohei Machida.
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator