maud/README.md

21 lines
1.2 KiB
Markdown
Raw Normal View History

2015-02-14 16:58:16 +13:00
# <img align="right" src="maud.png" alt="HTML5 rocks." title="HTML5 rocks."> maud [![Build Status](https://img.shields.io/travis/lfairy/maud.svg)](http://travis-ci.org/lfairy/maud) [![Cargo](https://img.shields.io/crates/v/maud.svg)](https://crates.io/crates/maud)
2014-12-17 21:11:56 +13:00
2016-10-09 19:05:58 +13:00
[Documentation][book] • [API reference][apiref] • [Change log][changelog]
2014-12-17 21:11:56 +13:00
2016-09-25 12:50:33 +13:00
Maud is an HTML template engine for Rust. It's implemented as a macro, `html!`, which compiles your markup to specialized Rust code. This unique approach makes Maud templates blazing fast, super type-safe, and easy to deploy.
2015-03-14 21:28:04 +13:00
2016-09-25 12:50:33 +13:00
Note that Maud depends on the unstable [syntax extension APIs][plugins], and so requires the Nightly version of Rust.
2015-03-14 21:28:04 +13:00
2016-09-25 12:50:33 +13:00
For more info on Maud, see the [official book][book].
2015-05-28 19:15:56 +12:00
2016-09-25 12:50:33 +13:00
[book]: https://maud.lambda.xyz/
[apiref]: https://lambda.xyz/maud/maud/
2016-10-09 19:05:58 +13:00
[changelog]: https://github.com/lfairy/maud/blob/master/CHANGELOG.md
2016-09-25 12:50:33 +13:00
[plugins]: https://doc.rust-lang.org/book/compiler-plugins.html
2015-05-28 19:15:56 +12:00
2016-09-25 12:50:33 +13:00
## Stability
2016-11-17 20:37:17 +13:00
As of version 0.11, I am satisfied with the core syntax and semantics of the library. Development at this stage is focused on adding features and fixing bugs.
2016-09-25 12:50:33 +13:00
The underlying syntax extension API is still unstable though, so updating your compiler may break things. Please file an issue when this happens!