Supported Markdown Syntax

Last updated September 28, 2026

The editor supports standard Markdown plus extensions like task lists, Mermaid diagrams, and wiki-style links.

Headings

Use # symbols to create headings. The number of # sets the level (1–6).

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text formatting

**Bold text**
*Italic text*
~~Strikethrough~~
`Inline code`

You can combine styles: ***bold and italic*** or ~~**strikethrough and bold**~~.

Lists

Bullet lists use -, *, or +:

- Item 1
- Item 2
- Item 3

Numbered lists use digits followed by a period:

1. First item
2. Second item
3. Third item

Task lists use [ ] and [x]. Checkboxes are interactive — click to toggle.

- [ ] Unchecked task
- [x] Completed task

Indent with 2 spaces to nest list items.

Code blocks

Use triple backticks with an optional language identifier for syntax highlighting:

```javascript
function greet(name) { return `Hello, ${name}!`; }
```

Supported languages include javascript, typescript, python, html, css, json, bash, and many more.

Tildes work as a fence too, and they are the way out when the code itself contains backticks:

~~~go
type TargetContext struct { RepoRoot string }
~~~

Close a fence with the same character you opened it with; the closing fence may be longer than the opening one. The editor keeps whichever style you used when you edit the block.

Mermaid diagrams

Code blocks with mermaid as the language render as diagrams:

```mermaid
graph TD A[Start] --> B{Decision} B -->|Yes| C[Action 1] B -->|No| D[Action 2]
```

Supported types: graph/flowchart, sequenceDiagram, classDiagram, stateDiagram, erDiagram, gantt, pie, and mindmap.

Links

Inline links:

[Link text](https://example.com)
[Link with title](https://example.com "Title text")

Reference links define the URL separately for cleaner text:

This is a [reference link][ref1] in the text.

[ref1]: https://example.com "Optional title"

Wiki links use double brackets for internal navigation. See Magic Links (Wiki Links) for details.

[[document-alias]]
[[alias|Display Label]]

Images

![Alt text](image-url)
![Alt text](image-url "Optional title")

Blockquotes

> This is a quote.
> It can span multiple lines.
>
> And have multiple paragraphs.

Tables

Use pipes and dashes to create tables. Colons control column alignment.

| Left   | Center | Right |
|:-------|:------:|------:|
| L      |   C    |     R |

Escape literal pipes with a backslash: \|.

Horizontal rules

Three or more dashes, asterisks, or underscores on their own line:

---

Escape a special character

A backslash turns a Markdown character back into an ordinary one:

\* Not italic \*
\# Not a heading
\[ Not a link \]
\` Not code \`

The one that catches people is the pipe. Inside a table cell a | ends the cell, so a pipe you want to show — and the pipe in a [[alias|Label]] link — has to be written \|.

Hard line breaks

End a line with two spaces to create a line break without starting a new paragraph.