italic bold bold and italic
- Numbered List
- With more items
- Sub lists are indented
- The numbers in any level of list need not be correct
- It can be confusing if the numbers don't match the reader's expectation
- Unordered lists
- Use asterisks in the first position
- Sub lists are indented
- Hyphens can be used to visually differentiate sublists
- As with numbered lists, * - and + are interchangable and do not need to be used consistently
- but it is best to use them consistently
When referring to things that should be rendered in a monospace font, such as file names or the names of classes. These should be surrounded with backticks.
Larger blocks of code should be surrounded with three back ticks.
def example():
return True
They can optionally have a language following the first three back ticks, to facilitate syntax highlighting
def example():
return TrueQuotations are declared with a leading right chevron and can cover multiple lines
Links and images are handled similarly to eachother, as a pair of square brackets that defines the text that should be shown followed by a pair of parentheses that contain the target URL.
Images are differentiated by having a leading exclamation mark:
Finally, tables use pipes to delimit columns and new lines to delimit rows. Hyphens are used to split the header row from the body, resulting in a very readable ASCII art style table:
| Multiplications | One | Two |
|---|---|---|
| One | 1 | 2 |
| Two | 2 | 4 |
However, the alignment is not important. The table will still render correctly even if the pipes are not aligned correctly. The row that contains the hyphens must include at least three hyphens per column, but otherwise the format is relatively forgiving.