sailfish/README.md at 18ffe5b321783ab15ebaaacff37211e82f28bc5b

3.2 KiB

Raw Blame History

Simple, small, and extremely fast template engine for Rust

✨ Features

Simple and intuitive syntax inspired by EJS
Relatively small number of dependencies (<15 crates in total)
Extremely fast (See benchmarks)
Better error message
Template rendering NEVER fails unless you explicitly return error.
Syntax highlighting support (vscode, vim)
Automatically re-compile sources when template file is updated.
Works on Rust 1.42 or later

🐟 Example

Dependencies:

[dependencies]
sailfish = "0.2.3"
sailfish-macros = "0.2.3"

Template file (templates/hello.stpl):

<html>
  <body>
    <% for msg in &messages { %>
      <div><%= msg %></div>
    <% } %>
  </body>
</html>

Code:

#[macro_use]
extern crate sailfish_macros;  // enable derive macro

use sailfish::TemplateOnce;

#[derive(TemplateOnce)]
#[template(path = "hello.stpl")]
struct HelloTemplate {
    messages: Vec<String>
}

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.)
Whitespace suppressing
Dynamic template compilation (RFC)
format_templates!(fmt, args..) macro

👤 Author

🇯🇵 Ryohei Machida

Github: @Kogia-sima

🤝 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 issue with Status: PR Welcome label, and let's create a new pull request!

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator

3.2 KiB Raw Blame History Unescape Escape