Markdown Cheat-sheet
Callouts
NOTE
General information.
> [!NOTE] > TEXT
TIP
Helpful advice.
> [!TIP] > Here's a tips
IMPORTANT
Important information.
> [!IMPORTANT] > Something really important
WARNING
Something requires caution.
CAUTION
High risk or dangerous.
SUCCESS
Success message.
QUESTION
Question or prompt.
FAILURE
Failure or error.
BUG
Bug report.
> [!BUG] > That not a bug, that's a feature.
EXAMPLE
Example.
> [!EXAMPLE] > An exemple of an exemple callout
QUOTE
Quote or citation.
> [!QUOTE] > By Einstain - Time is relative
Foldable Callouts
Closed by default
Hidden content.
> [!NOTE]- Closed ... > Content
Open by default
Visible content.
> [!TIP] > Content
Internal Links
[[Note]]
[[Note|Display Name]]
[[Note#Heading]]
[[Note#Heading|Display Name]]
[[Note#^block-id]]
[[Note#^block-id|Display Name]]
Code Blocks
const x: u8 = 42;Specify the language after the opening back-ticks for syntax highlighting.
Tables
Rendered
| Name | Type |
|---|---|
| data | []u8 |
| len | usize |
Code
| Heading 1 | ... | Heading N |
|:---------:| ... |:---------:|
| Content | ... | Content |
| Content | ... | Content |Check-boxes
Rendered
- To do
- Done
- Cancelled
Code
- [ ] To do
- [x] Done
- [-] Cancelled Footnotes
Zig is fast.1
Escaping Markdown
\*Not italic\*
\# Not a heading
\`Not code\`
Footnotes
-
Because it compiles to native code. ↩