michael/sailfish
michael
/
sailfish
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: update documents

This commit is contained in:
Kogia-sima 2020-12-25 13:21:56 +09:00
parent 92c8f8a852
commit dece98d957
2 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/docs/index.md
View File

@ -11,8 +11,9 @@ 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
- Relatively small number of dependencies (<15 crates in total)
- Extremely fast (See [benchmarks](http://github.com/Kogia-sima/sailfish/blob/master/benches))
- Extremely fast (See [benchmarks](https://github.com/djc/template-benchmarks-rs))
- Better error message
- Template rendering is always type-safe because templates are statically compiled.
- Syntax highlighting ([vscode](http://github.com/Kogia-sima/sailfish/blob/master/syntax/vscode), [vim](http://github.com/Kogia-sima/sailfish/blob/master/syntax/vim))
@ -22,9 +23,8 @@ There are many libraries for template rendering in Rust. Among those libraries,
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:
- Dynamic Template Loading
- Filter
- `Template` trait (which does not consume itself)
- Template inheritance (block, partials, etc.)
If you have any idea about them or want to implement that feature, please send a comment on the issue!

3
docs/en/docs/installation.md
View File

@ -10,6 +10,3 @@ sailfish = "0.3.0"
`sailfish` crate contains runtime for rendering contents, and `sailfish-macros` serves you derive macros to compile and import the template files.
These crates are separated so that Rust compiler can compile them independently. This separation makes your compilation faster!
!!! Warning
Make sure that the `sailfish-macros` version is larger than `sailfish`, otherwise the compilation may fail.