Skip to content

Markdown syntax

All Writer uses Milkdown with full CommonMark-style Markdown plus common extensions.

Headings

markdown
# H1 … ###### H6

Headings appear in the outline panel.

Paragraphs and line breaks

Separate paragraphs with a blank line. For a line break inside a paragraph, end the line with two spaces or use a blank line between short lines.

Emphasis

markdown
*italic*  **bold**  ***bold italic***

Lists

Unordered

markdown
- Item
- Item
  - Nested

Ordered

markdown
1. First
2. Second
markdown
[Link text](https://example.com)
![Alt text](/images/example.png)

Code

Inline `code` and fenced blocks with language:

markdown
```typescript
const x = 1;
```

See Code highlighting.

Tables

markdown
| A | B |
|---|---|
| 1 | 2 |

Task lists

markdown
- [ ] Todo
- [x] Done

Blockquotes

markdown
> Quoted text

Math (KaTeX)

$inline$ and $$ block equations—see Math.

Diagrams (Mermaid)

Fenced code blocks with mermaid—see Diagrams.

Horizontal rule

markdown
---

More