Markdown Support
We support all standard Markdown features (actually, we're using GitHub-flavored Markdown).
Headings
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Text Formatting
Bold text
Italic text
Strikethrough text
Inline code
**Bold text**
*Italic text*
~~Strikethrough text~~
`Inline code`
Lists
- Unordered list item
- Another item
- Nested item
- Another nested item
- Unordered list item
- Another item
- Nested item
- Another nested item
- Ordered list item
- Another item
- Nested item
- Another nested item
1. Ordered list item
2. Another item
1. Nested item
2. Another nested item
Links and Images
[Absolute URLs](https://example.com)
[Relative link](../another-markdown-file.md)
Code Blocks
```javascript
function example() {
return "Hello, World!";
}
```
function example() {
return "Hello, World!";
}
Blockquotes
This is a blockquote
It can span multiple lines
> This is a blockquote
>
> It can span multiple lines
Tables
| Header 1 | Header 2 | Header 3 |
|---|---|---|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
| Header 1 | Header 2 | Header 3 |
| -------- | -------- | -------- |
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
Task Lists
- [x] Completed task
- [ ] Pending task
- [ ] Another pending task
Hints
We support GitHub-style alerts for highlighting important information:
Useful information that users should know, even when skimming content.
Helpful advice for doing things better or more easily.
Key information users need to know to achieve their goal.
Urgent info that needs immediate user attention to avoid problems.
Advises about risks or negative outcomes of certain actions.
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
