diff --git a/docs/README.md b/docs/README.md index e148527..0349fa3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,8 @@ This directory contains the documentation for Maud. +It is hosted at <https://maud.lambda.xyz>. + ## Build Build the documentation: @@ -14,6 +16,18 @@ You can also delete the build artifacts with: make clean +## Style + +- [Be brief][short]. +- Use [semantic line breaks][sembr]. +- American spelling. +- Parentheticals should use spaced en dashes – + like this – + not em dashes. + +[short]: https://developers.google.com/tech-writing/one/short-sentences +[sembr]: https://sembr.org/ + ## Watch To ease editing, diff --git a/docs/content/elements-attributes.md b/docs/content/elements-attributes.md index 1349c9a..400f791 100644 --- a/docs/content/elements-attributes.md +++ b/docs/content/elements-attributes.md @@ -89,9 +89,10 @@ html! { ## Optional attributes: `title=[Some("value")]` -Add optional attributes to an element using `attr=[value]` syntax, with *square* -brackets. These are only rendered if the value is `Some<T>`, and entirely -omitted if the value is `None`. +Add optional attributes to an element using `attr=[value]` syntax, +with *square* brackets. +These are only rendered if the value is `Some<T>`, +and entirely omitted if the value is `None`. ```rust # let _ = maud:: diff --git a/docs/content/web-frameworks.md b/docs/content/web-frameworks.md index fb05fd4..7730d9b 100644 --- a/docs/content/web-frameworks.md +++ b/docs/content/web-frameworks.md @@ -118,8 +118,10 @@ maud = { version = "*", features = ["tide"] } # ... ``` -This adds an implementation of `From<PreEscaped<String>>` for the `Response` struct. -Once provided, callers may return results of `html!` directly as responses: +This adds an implementation of `From<PreEscaped<String>>` +for the `Response` struct. +Once provided, +callers may return results of `html!` directly as responses: ```rust,no_run use maud::html;