Headers¶
# H1
## H2
### H3
#### H4
##### H5
###### H6
On this site, the page title comes from front matter, so page content should start at ## (H2) rather than #.
Emphasis¶
*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~
Blockquote¶
> A single-line quote
> A multi-line quote
> that spans two lines
Nested quotes:
> Outer quote
>> Nested quote
Lists¶
Unordered¶
- Item one
- Item two
- Nested item
Ordered¶
1. Item one
2. Item two
1. Nested item
Task list¶
- [ ] Not done
- [x] Done
Links¶
[link text](https://example.com)
[link with title](https://example.com "hover title")
Reference-style (useful for reusing the same URL multiple times):
[link text][ref]
[ref]: https://example.com
Images¶


Code¶
Inline code¶
Use the `git status` command.
Fenced code block¶
echo "hello world"
Adding a language after the opening triple-backtick (```bash, ```python, ```yaml, etc.) enables syntax highlighting.
Indented code block (alternative to fencing)¶
This is a code block
indented with 4 spaces
Horizontal rule¶
---
Three or more hyphens, asterisks, or underscores on their own line all work (---, ***, ___).
Tables¶
| Column A | Column B |
|----------|----------|
| Value 1 | Value 2 |
| Value 3 | Value 4 |
Renders as:
| Column A | Column B |
|---|---|
| Value 1 | Value 2 |
| Value 3 | Value 4 |
Alignment:
| Left | Center | Right |
|:-----|:------:|------:|
| a | b | c |
Footnotes¶
Here's a sentence with a footnote.[^1]
[^1]: This is the footnote text.
Line breaks¶
Markdown collapses single newlines within a paragraph. To force a line break, end the line with two trailing spaces or use <br>:
First line
Second line
To start a new paragraph, leave a fully blank line between blocks of text.
Escaping characters¶
Prefix a special character with a backslash to render it literally instead of as Markdown syntax:
\*not italic\*
\# not a header
Emojis¶
Most Markdown renderers that support emoji shortcodes (including GitHub, GitLab, and Hugo with the right config) accept :shortcode: syntax:
:thumbsup:
:thumbsdown:
:tada:
:rocket:
:warning:
:white_check_mark:
:x:
:bulb:
:fire:
Full shortcode list: https://gist.github.com/rxaviers/7360908