How to format posts on Lemmy using Markdown
Lemmy uses markdown-it for rendering markdown. This means that you can use the same markdown syntax that you would use on Lemmy and it follows the CommonMark spec. Here are some examples of markdown that you can use on Lemmy:
Headers
markdown
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
Result:
![Markdown Headers](/img/guide/markdown/headers_dark.png)
![Markdown Headers](/img/guide/markdown/headers_light.png)
Emphasis
markdown
*italic*
**bold**
***bold italic***
~~strikethrough~~
Result:
![Markdown Emphasis](/img/guide/markdown/emphasis_dark.png)
![Markdown Emphasis](/img/guide/markdown/emphasis_light.png)
Lists
markdown
- Unordered list item 1
- Unordered list item 2
- Unordered list item 2.1
- Unordered list item 2.2
- Unordered list item 3
1. Ordered list item 1
2. Ordered list item 2
3. Ordered list item 3
Result:
![Markdown Emphasis](/img/guide/markdown/lists_dark.png)
![Markdown Emphasis](/img/guide/markdown/lists_light.png)
Links / Images
markdown
[Link text](https://example.com)
![Image Alt](https://example.com/image.jpg "Image title")
![The fedecan Logo](https://fedecan.ca/img/icons/maple-leaf.svg "Maple Leaf")
Result:
![Markdown Links/Images](/img/guide/markdown/links_images_dark.png)
![Markdown Links/Images](/img/guide/markdown/links_images_light.png)
Blockquotes
markdown
> Block
> -quote
Result:
![Markdown Blockquotes](/img/guide/markdown/blockquotes_dark.png)
![Markdown Blockquotes](/img/guide/markdown/blockquotes_light.png)
Code
markdown
`inline code`
```python
def hello():
print("Hello, World!")
```
Result:
![Markdown Inline/Blockcode](/img/guide/markdown/code_dark.png)
![Markdown Inline/Blockcode](/img/guide/markdown/code_light.png)
Tables
Tables are not officially documented.
markdown
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1 | Row 1 | Row 1 |
| Row 2 | Row 2 | Row 2 |
| Row 3 | Row 3 | Row 3 |
Result:
![Markdown Tables](/img/guide/markdown/tables_dark.png)
![Markdown Tables](/img/guide/markdown/tables_light.png)
Horizontal Rule
markdown
---
Result:
![Markdown Horizontal Rule](/img/guide/markdown/horizontal_rule_dark.png)
![Markdown Horizontal Rule](/img/guide/markdown/horizontal_rule_light.png)
Spoilers
Warning: Spoilers are not yet fully implemented on Apps and may not work as expected on them.
markdown
::: spoiler Spoiler Name
Spoiler Content
:::
Result:
![Markdown Spoilers](/img/guide/markdown/spoilers_dark.png)
![Markdown Spoilers](/img/guide/markdown/spoilers_light.png)
Note: In the example above, the spoiler is in the open state, by default it is in the closed state.
Sub/Superscript
markdown
H~2~O
H^2^O
Result:
![Markdown Sub/Superscript](/img/guide/markdown/sub_superscript_dark.png)
![Markdown Sub/Superscript](/img/guide/markdown/sub_superscript_light.png)