#template #html #markup

macro sailfish-macros

Simple, small, and extremely fast template engine for Rust

27 releases

0.8.4-beta.1 Feb 20, 2024
0.8.3 Oct 22, 2023
0.8.0 Jul 28, 2023
0.6.0 Jan 24, 2023
0.2.0 Jul 16, 2020

#417 in Template engine

Download history 1404/week @ 2023-11-23 1064/week @ 2023-11-30 1152/week @ 2023-12-07 964/week @ 2023-12-14 730/week @ 2023-12-21 750/week @ 2023-12-28 1099/week @ 2024-01-04 1174/week @ 2024-01-11 1010/week @ 2024-01-18 747/week @ 2024-01-25 841/week @ 2024-02-01 848/week @ 2024-02-08 874/week @ 2024-02-15 1034/week @ 2024-02-22 1392/week @ 2024-02-29 926/week @ 2024-03-07

4,373 downloads per month
Used in sailfish

MIT license

90KB
2K SLoC

SailFish

Simple, small, and extremely fast template engine for Rust

Tests Version dependency status Rust 1.60 License: MIT

User Guide | API Docs | 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:

[dependencies]
sailfish = "0.8.4-beta.1"

Template file (templates/hello.stpl):

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

Code:

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.)

👤 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

Dependencies

~0.6–12MB
~100K SLoC