Markdown

2025.12.09

Headings

SyntaxDescription
# Heading 1Largest heading (H1)
## Heading 2Section heading (H2)
### Heading 3Subsection (H3)
#### Heading 4Small heading (H4)
##### Heading 5Smaller heading (H5)
###### Heading 6Smallest heading (H6)

Text Formatting

SyntaxDescription
**bold**Bold text
*italic*Italic text
***bold italic***Bold and italic
~~strikethrough~~Strikethrough
`inline code`Inline code
<sup>superscript</sup>Superscript
<sub>subscript</sub>Subscript

Lists

SyntaxDescription
- itemUnordered list
* itemUnordered list (alternative)
1. itemOrdered list
- childNested list (2 spaces)
- [ ] taskCheckbox (unchecked)
- [x] taskCheckbox (checked)
SyntaxDescription
[text](URL)Hyperlink
[text](URL "title")Link with title
<URL>Auto link
![alt](image URL)Image
![alt](URL "title")Image with title
[ref][id][id]: URLReference link

Code Blocks

SyntaxDescription
```Code block start/end
```javascriptCode block with language
```pythonPython code block
```bashShell commands
code4-space indent also works

Tables

SyntaxDescription
| col1 | col2 |Table row
|---|---|Header separator
|:---|Left align
|:---:|Center align
|---:|Right align

Blockquotes and Separators

SyntaxDescription
> quote textBlockquote
>> nested quoteNested blockquote
---Horizontal rule
***Horizontal rule (alternative)
___Horizontal rule (alternative)

Extended Syntax (GitHub Flavored Markdown)

SyntaxDescription
@usernameUser mention
#123Issue/PR reference
:emoji:Emoji (e.g., :smile:)
==highlight==Highlighted text
^footnote^Footnote
[^1][^1]: noteDetailed footnote format

Escaping

SyntaxDescription
\*Escape asterisk
\#Escape hash
\[Escape bracket
\\Backslash itself
← Back to list