Formatting Standards
For consistency across all examples in the docs and to ensure that our code examples are readable, please follow these guidelines when contributing:
- Four spaces for indentation, and always use proper indentation
- Multiple-line formatting (one property and value per line)
- Double quotes only, never single quotes
- Always put a space after a property's colon (.e.g,
display: block;and notdisplay:block;) - End all lines with a semi-colon
- For multiple, comma-separated selectors, place each selector on its own line
- Attribute selectors, like
input[type="text"]should always wrap the attribute's value in double quotes. This is important to do in your own code as well for consistency and safety (see this blog post on unquoted attribute values that can lead to XSS attacks) - When using HTML in your examples, use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags with no trailing slash)
- All page files should have globally unique names regardless of where they are located in the repository
- Nouns (man, bus, book)
- Adjectives (angry, lovely, small)
- Verbs (run, eat, sleep)
- Adverbs (slowly, quickly, quietly)
- Pronouns (he, she, it)
- Subordinating conjunctions (as, because, that)
- Articles: a, an, the
- Coordinating Conjunctions: and, but, or, for, nor, etc.
- Prepositions: on, at, to, from, by, etc.
- Visit Assemble's documentation site to learn more about customization and configuration.
- Markdown: Markdown Cheatsheet
Examples:
Good
body {
padding-top: 80px;
font-size: 12px;
}Bad
body {
padding-top: 80px;
font-size: 12px;
}Bad
body { padding-top: 80px; font-size: 12px }- If you would like to request a feature, suggest an improvement, or report a bug, please [submit an Issue]({{ site.codeissues }}).
- Feature requests are more likely to get attention if you include a clearly-described use case.