From 9b1402101da7272786cde3113dc6c680824838ba Mon Sep 17 00:00:00 2001 From: Chris Wong <lambda.fairy@gmail.com> Date: Sat, 24 Jan 2015 23:42:38 +1300 Subject: [PATCH] Add some more docs --- maud/src/lib.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/maud/src/lib.rs b/maud/src/lib.rs index 205227c..f257396 100644 --- a/maud/src/lib.rs +++ b/maud/src/lib.rs @@ -37,6 +37,9 @@ //! //! Maud uses its own syntax, loosely inspired by HTML and Rust. //! +//! **Note:** The markup you see below has been cleaned up a bit. In +//! reality, Maud doesn't add extra whitespace to the HTML it generates. +//! //! ## Literals //! //! ``` @@ -53,7 +56,8 @@ //! <script>alert("XSS")</script> //! ``` //! -//! Literal strings use the same syntax as Rust. +//! Literal strings use the same syntax as Rust. Wrap them in +//! double quotes, and use a backslash for escapes. //! //! By default, HTML special characters are escaped automatically. Add a //! `$$` prefix to disable this escaping.