Go to file
Kogia-sima 6b0d67cd49 Add THIRD_PARTY 2020-12-23 22:39:31 +09:00
.github/workflows Fix installation of multilib 2020-12-19 23:49:33 +09:00
benches Remove benchmarks 2020-12-17 12:51:42 +09:00
docs doc: no longer requires `extern crate sailfish_macros` 2020-12-20 22:24:31 +09:00
examples Bump version (0.2.3 => 0.3.0) 2020-12-20 22:16:25 +09:00
resources Resize icon for docs.rs 2020-06-18 01:04:10 +09:00
sailfish fix: Fix compilation issue with Cow<'a, str> 2020-12-21 17:02:32 +09:00
sailfish-compiler Bump version (0.2.3 => 0.3.0) 2020-12-20 22:16:25 +09:00
sailfish-macros Bump version (0.2.3 => 0.3.0) 2020-12-20 22:16:25 +09:00
sailfish-tests Bump version (0.2.3 => 0.3.0) 2020-12-20 22:16:25 +09:00
scripts skip test in 1.42.0 2020-06-16 22:59:58 +09:00
syntax fix: Fix vim syntax highlighting 2020-07-18 09:31:23 +09: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 Update CHANGELOG 2020-08-04 09:28:28 +09:00
Cargo.lock Bump version (0.2.3 => 0.3.0) 2020-12-20 22:16:25 +09: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 doc: no longer requires `extern crate sailfish_macros` 2020-12-20 22:24:31 +09:00
THIRD_PARTY Add THIRD_PARTY 2020-12-23 22:39:31 +09:00
netlify.toml Add documentation sources 2020-06-09 21:19:59 +09:00
requirements.txt Add documentation sources 2020-06-09 21:19:59 +09: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 License: MIT

User Guide | API Docs | Examples

Features

  • Simple and intuitive syntax inspired by EJS
  • Builtin filters
  • Relatively small number of dependencies (<15 crates in total)
  • Extremely fast (See benchmarks)
  • Better error message
  • 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.3.0"

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

Copyright © 2020 Ryohei Machida.

This project is MIT licensed.


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