diff --git a/README.md b/README.md index 93137b5..ba2929f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Simple, small, and extremely fast template engine for Rust ## ✨ Features - Simple and intuitive syntax inspired by [EJS](https://ejs.co/) -- Builtin filters +- Built-in filters - Relatively small number of dependencies (<15 crates in total) - Extremely fast (See [benchmarks](https://github.com/djc/template-benchmarks-rs)) - Better error message @@ -74,7 +74,7 @@ You can find more examples in [examples](./examples) directory. 🇯🇵 **Ryohei Machida** -* Github: [@Kogia-sima](https://github.com/Kogia-sima) +* GitHub: [@Kogia-sima](https://github.com/Kogia-sima) ## 🤝 Contributing diff --git a/benches/README.md b/benches/README.md index 429aa48..ed1f5fb 100644 --- a/benches/README.md +++ b/benches/README.md @@ -1 +1 @@ -benchmark programs were removed in favor of https://github.com/djc/template-benchmarks-rs +benchmark programs were removed in favour of https://github.com/djc/template-benchmarks-rs diff --git a/docs/en/docs/index.md b/docs/en/docs/index.md index e83c76a..d5fa229 100644 --- a/docs/en/docs/index.md +++ b/docs/en/docs/index.md @@ -10,8 +10,8 @@ Currently the documentation is uncompleted. If you want to improve our documenta There are many libraries for template rendering in Rust. Among those libraries, sailfish aims at **rapid development** and **rapid rendering**. Sailfish has many features that other libraries might not support. -- Write a Rust code directly inside templates, supporting many Rust syntax (struct definision, closure, macro invocation, etc.) -- Builtin filters +- Write a Rust code directly inside templates, supporting many Rust syntax (struct definition, closure, macro invocation, etc.) +- Built-in filters - Relatively small number of dependencies (<15 crates in total) - Extremely fast (See [benchmarks](https://github.com/djc/template-benchmarks-rs)) - Better error message @@ -21,7 +21,7 @@ There are many libraries for template rendering in Rust. Among those libraries, ## Upcoming features -Since sailfish is on early stage of development, there are many upcoming features that is not supported yet. You can find many [RFC](https://github.com/Kogia-sima/sailfish/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+RFC%22)s in my repository. These RFCs include: +Since sailfish is on early stage of development, there are many upcoming features that is not supported yet. You can find many [RFC](https://github.com/Kogia-sima/sailfish/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+RFC%22)s in my repository. These RFC include: - `Template` trait (which does not consume itself) - Template inheritance (block, partials, etc.) diff --git a/docs/en/docs/syntax/filters.md b/docs/en/docs/syntax/filters.md index c2b4e24..e5bf32d 100644 --- a/docs/en/docs/syntax/filters.md +++ b/docs/en/docs/syntax/filters.md @@ -15,7 +15,7 @@ message: "foo\nbar" ``` !!! Note - Since `dbg` filter accepts '' types, that type isn't required to implement [`Render`](https://docs.rs/sailfish/latest/sailfish/runtime/trait.Render.html) trait. That means you can pass the type which doen't implement `Render` trait. + Since `dbg` filter accepts '' types, that type isn't required to implement [`Render`](https://docs.rs/sailfish/latest/sailfish/runtime/trait.Render.html) trait. That means you can pass the type which doesn't implement `Render` trait. ## Syntax diff --git a/docs/rfcs/1-dynamic-loading.md b/docs/rfcs/1-dynamic-loading.md index c22bce0..a722458 100644 --- a/docs/rfcs/1-dynamic-loading.md +++ b/docs/rfcs/1-dynamic-loading.md @@ -63,7 +63,7 @@ AllocVtable is passed to template function, and then VBuffer is constructed insi VBuffer should always use AllocVTable to allocate/reallocate a new memory. That cannot achieve with `std::string::String` struct only. We must re-implement the `RawVec` struct. -## Rust standard library confliction problem +## Rust standard library conflict problem Rarely, but not never, dynamically compiled templates may use different version of standard library. @@ -77,7 +77,7 @@ We must ensure that all of the data passed to templates should satisfy the follo - completely immutable - does not allocate/deallocate memory -- can be serialized to/deserialized from byte array (All data is serealized to byte array, and then decoded inside templates) +- can be serialized to/deserialized from byte array (All data is serialized to byte array, and then decoded inside templates) - can be defined inside `#![no_std]` crate Sailfish provide `TemplateData` trait which satisfies the above restrictions.