Skip to content

Basic Formatting

Headings

Use headings to create a table of contents for the document and site. They are used to apply layout and create a navigation structure.

To create a heading, add number signs (#) in front of a word or phrase. The number of signs correspond to the heading level.

Syntax Result
# Heading 1

Heading 1
## Heading 2

Heading 2
### Heading 3

Heading 3
#### Heading 4

Heading 4
##### Heading 5
Heading 5
###### Heading 6
Heading 6

Markdown rules

  1. First line in a file should be Heading 1
  2. A file only has one Heading 1
  3. Heading levels should only increment by one level at a time

Text Formatting

Use text formatting to style a word or phrase. Different formats can be combined to e.g. create a bold & italic (_**bold & italic**_) word.

Syntax Result
**bold** bold
_italic_ italic
^^underline^^ underline
==highlight== highlight
~~strike through~~ strike through
`Inline Code` Inline Code
~sub~script subscript
^super^script superscript

Horizontal Rules

To create a horizontal rule, use three or more dashes (---), asterisks (***), or underscores (___) on a line by themselves.

Text above Horizontal rule

---

Text below Horizontal rule

Text above Horizontal rule

Text below Horizontal rule

Markdown rules

  1. Put a blank line before and after the Horizontal rule otherwise you create a Heading