Go to file
Michael Pfaff e4def7d21c Add some more common escaping scheme identity checks 2024-03-15 19:50:21 -04:00
.github Bump MSRV to 1.60.0 2023-03-05 20:28:28 +09:00
assets/javascripts/workers/templates Improve comment syntax 2024-03-11 22:42:08 -04:00
benches doc: Fix typo 2021-01-01 18:21:39 +09:00
docs Refactor to support custom escaping schemes 2024-03-15 18:05:31 -04:00
examples Refactor to support custom escaping schemes 2024-03-15 18:05:31 -04:00
resources Resize icon for docs.rs 2020-06-18 01:04:10 +09:00
sailfish Add some more common escaping scheme identity checks 2024-03-15 19:50:21 -04:00
sailfish-compiler Allow any ASCII whitespace instead of just space after `<%` 2024-03-15 18:47:29 -04:00
sailfish-macros Unify Render* and Template* traits 2024-03-11 17:33:11 -04:00
sailfish-tests Refactor to support custom escaping schemes 2024-03-15 18:05:31 -04:00
scripts Update Cargo.lock, and then create a new Release tag 2023-07-28 10:38:47 -04:00
syntax Refactor to support custom escaping schemes 2024-03-15 18:05:31 -04:00
.gitattributes Add .gitattributes 2020-06-10 00:00:20 +09:00
.gitignore Add source code 2020-06-05 22:31:38 +09:00
CHANGELOG.md Add breaking `config` feature change to CHANGELOG.md 2023-06-21 09:30:54 +02:00
Cargo.toml Remove benchmarks 2020-12-17 12:51:42 +09:00
LICENSE Add source code 2020-06-05 22:31:38 +09:00
README.md Refactor to support custom escaping schemes 2024-03-15 18:05:31 -04:00
THIRD_PARTY Add THIRD_PARTY 2020-12-23 22:39:31 +09:00
codecov.yml Add codecov.yml 2020-12-30 03:26:24 +09:00
netlify.toml Add documentation sources 2020-06-09 21:19:59 +09:00
requirements.txt Update actix.stpl, header.stpl, and 53 more files... 2022-11-29 16:34:26 -05:00
runtime.txt Update Python version 2020-06-09 21:34:46 +09:00
rustfmt.toml Add source code 2020-06-05 22:31:38 +09:00

README.md

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.3"

Template file (templates/hello.stpl):

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

Code:

use sailfish::RenderOnce;

#[derive(RenderOnce)]
#[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

  • Render derive macro (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