itsscb/askama
1
0
Fork 0
mirror of https://github.com/askama-rs/askama.git synced 2025-09-28 13:30:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve feature documentation in README and docs

Browse Source
This commit is contained in:
Dirkjan Ochtman 2017-03-08 20:33:55 +01:00
parent 39ec850b4a
commit e558318dd2
2 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -12,16 +12,26 @@ See below for an example, or read [the documentation][docs].
**"Pretty exciting. I would love to use this already."** -- **"Pretty exciting. I would love to use this already."** --
[Armin Ronacher][mitsuhiko], creator of Jinja [Armin Ronacher][mitsuhiko], creator of Jinja
Currently implemented features: ### Feature highlights
* Construct templates using a familiar, easy-to-use syntax
* Benefit from the safety provided by Rust's type system
* Template code is compiled into your crate for optimal performance
* Templates only convert your data as needed
* Templates can access your Rust types directly, according to Rust's
privacy rules
* Debugging features to assist you in template development
* Templates must be valid UTF-8 and produce UTF-8 when rendered
* Works on stable Rust
### Supported in templates
* Generates fully type-safe Rust code from your templates
* Template inheritance * Template inheritance
* Basic loops and if/else if/else statements * Basic loops and if/else if/else statements
* Whitespace suppressing with '-' markers * Whitespace suppressing with '-' markers
* Some built-in filters * Some built-in filters
* Works on stable Rust
Askama is in heavy development, so it currently has some limitations: It's still early for Askama, so there are some limitations:
* Only a small number of built-in template filters have been implemented * Only a small number of built-in template filters have been implemented
* User-defined template filters are not supported yet * User-defined template filters are not supported yet

8
askama/src/lib.rs
View File

@ -20,14 +20,14 @@
//! # Feature highlights //! # Feature highlights
//! //!
//! * Construct templates using a familiar, easy-to-use syntax //! * Construct templates using a familiar, easy-to-use syntax
//! * Fully benefit from the safety provided by Rust's type system //! * Benefit from the safety provided by Rust's type system
//! * Templates do not perform eager conversion to strings or other types
//! * Template code is compiled into your crate for optimal performance //! * Template code is compiled into your crate for optimal performance
//! * Templates can directly access your Rust types, according to Rust's //! * Templates only convert your data as needed
//! * Templates can access your Rust types directly, according to Rust's
//! privacy rules //! privacy rules
//! * Debugging features to assist you in template development //! * Debugging features to assist you in template development
//! * Included filter functions will provide easy access to common functions
//! * Templates must be valid UTF-8 and produce UTF-8 when rendered //! * Templates must be valid UTF-8 and produce UTF-8 when rendered
//! * Works on stable Rust
//! //!
//! # Creating Askama templates //! # Creating Askama templates
//! //!