Formatting Text
Lists
Try to use list elements when offering lists of information or options to preserve semantic markup. Note that both our style guide menu and the topics section are built using lists.
Ordered Lists
<ol>
elements should be used when the order of the items in the list is important.
Best Animals
- parrots
- tuatara
- octopuses
Unordered Lists
<ul>
elements should be used when the order of the list isn't important.
Shopping List
- milk
- eggs
- bread
Ninja Lists
.simple-list
can be added as a class to either an ordered list or unordered list to remove the visual list item styling (number or maker) in favor of more neutral styling. The overview employs this.
If you need to otherwise style a list item as a one-off, that's okay.
Logs
Logs are a special kind of list. <ol class="list">
can be used (class also applies to ULs if logs are not ordered).
Code
Here are some tips for formatting code to be presented in plain text on the web:
<code>
tags visually mark text as code<
and>
can be used to escape < and > in these blocks<code class="multi-line">
can be used for multi-line code blocks
Code blocks can be very visually distracting, so try to group them if you can.
# Some _why plagiarism to demonstrate a multi-line code block
print( if at_hotel.nil?
"No clue if he's in the hotel."
elsif at_hotel == true
"Definitely in."
elsif at_hotel == false
"He's out."
else
"The system is on the freee-itz."
end )
Statistics
You can use the following to show statistics, etc.: <table class="stats">
Contiguous States | 48 |
Total States | 50 |
Population | 325.7 million |
GDP per capita | 57,466.79 USD |
Example Text
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Section 1.10.32 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
Some imaginary logs
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [aaaaaaaaa] performed [bbbbbbbbb] on [cccccccccccccc]
- - [entity] performed [action] on [object]
- - [entity with unusually long name] performed [action with unusually long name] on [object with unusually long name]
- - [entity] performed [action] on [object]
- - [ent] performed [act] on [obj]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [other entity] performed [other action] on [other object]
- - [entity] performed [action] on [object]
- - system restart
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [a] performed [b] on [c]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [skdjflskjdfsdf] performed [skjdflkjsdlfkj] on [sdkfjsldkjfl]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [e] performed [a] on [o]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [11111111] performed [222222] on [333333333]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [a] performed [b] on [c]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]
- - [entity] performed [action] on [object]