2020-06-04 16:39:33 -04:00
< div align = "center" >
Simple, small, and extremely fast template engine for Rust
2020-06-06 16:00:37 -04:00
[](https://travis-ci.org/Kogia-sima/sailfish)
2020-06-09 08:47:06 -04:00
[](https://ci.appveyor.com/project/Kogiasima/sailfish/branch/master)
2020-06-05 10:42:06 -04:00
[](https://crates.io/crates/sailfish)
[](https://github.com/Kogia-sima/sailfish/blob/master/LICENSE)
2020-06-09 08:48:39 -04:00
[User Guide ](https://sailfish.netlify.app/en/ ) | [API Docs ](https://docs.rs/sailfish ) | [Examples ](./examples )
2020-06-04 16:39:33 -04:00
< / div >
## ✨ Features
- Simple and intuitive syntax inspired by [EJS ](https://ejs.co/ )
- Relatively small number of dependencies (< 15 crates in total )
2020-12-15 23:38:17 -05:00
- Extremely fast (See [benchmarks ](https://github.com/djc/template-benchmarks-rs ))
2020-06-04 16:39:33 -04:00
- Better error message
2020-07-02 05:28:22 -04:00
- Template rendering NEVER fails unless you explicitly return error.
2020-06-04 16:39:33 -04:00
- Syntax highlighting support ([vscode](./syntax/vscode), [vim ](./syntax/vim ))
- Automatically re-compile sources when template file is updated.
2020-06-16 11:08:40 -04:00
- Works on Rust 1.42 or later
2020-06-04 16:39:33 -04:00
## 🐟 Example
Dependencies:
```toml
[dependencies]
2020-11-29 07:40:58 -05:00
sailfish = "0.2.3"
2020-12-16 10:04:47 -05:00
sailfish-macros = "0.2.3"
2020-06-04 16:39:33 -04:00
```
Template file (templates/hello.stpl):
2020-06-08 00:14:09 -04:00
```erb
2020-06-04 16:39:33 -04:00
< html >
< body >
2020-06-19 05:27:19 -04:00
< % for msg in & messages { %>
< div > < %= msg %>< / div >
< % } %>
2020-06-04 16:39:33 -04:00
< / body >
< / html >
```
Code:
```rust
2020-12-16 10:04:47 -05:00
#[macro_use]
extern crate sailfish_macros; // enable derive macro
2020-06-04 16:39:33 -04:00
use sailfish::TemplateOnce;
#[derive(TemplateOnce)]
#[template(path = "hello.stpl")]
2020-06-19 05:27:19 -04:00
struct HelloTemplate {
messages: Vec< String >
2020-06-04 16:39:33 -04:00
}
fn main() {
2020-06-19 05:27:19 -04:00
let ctx = HelloTemplate {
messages: vec![String::from("foo"), String::from("bar")]
}
println!("{}", ctx.render_once().unwrap());
2020-06-04 16:39:33 -04:00
}
```
You can find more examples in [examples ](./examples ) directory.
## 🐾 Roadmap
2020-06-07 00:41:08 -04:00
- `Template` trait ([RFC](https://github.com/Kogia-sima/sailfish/issues/3))
2020-06-04 16:39:33 -04:00
- Template inheritance (block, partials, etc.)
- Whitespace suppressing
2020-06-07 00:41:08 -04:00
- Dynamic template compilation ([RFC](https://github.com/Kogia-sima/sailfish/issues/1))
2020-06-04 16:39:33 -04:00
- `format_templates!(fmt, args..)` macro
## 👤 Author
2020-07-02 05:28:22 -04:00
🇯🇵 **Ryohei Machida**
2020-06-04 16:39:33 -04:00
* Github: [@Kogia-sima ](https://github.com/Kogia-sima )
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
2020-06-19 05:27:19 -04:00
Since sailfish is an immature library, there are many [planned features ](https://github.com/Kogia-sima/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 issue with [Status: PR Welcome ](https://github.com/Kogia-sima/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/Kogia-sima/sailfish/pulls )!
2020-06-04 16:39:33 -04:00
## 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/Kogia-sima/sailfish/blob/master/LICENSE ) licensed.
***
_This README was generated with ❤️ by [readme-md-generator ](https://github.com/kefranabg/readme-md-generator )_
