Markdown Syntax
Markdown Syntax Guide
Pages are written in Markdown. Here's a reference for the most common formatting options.
Text formatting
| Syntax | Result |
|---|---|
**bold** |
bold |
*italic* |
italic |
~~strikethrough~~ |
strikethrough |
`inline code` |
inline code |
Headings
## Heading 2
### Heading 3
#### Heading 4
Headings automatically appear in the Table of Contents sidebar on wider screens. The TOC highlights the section you're currently reading as you scroll. Each heading also gets a ¶ anchor link you can click (or copy) to link directly to that section.
Links and images
[Link text](https://example.com)
To link to another wiki page, use the #slug syntax (see Linking Pages).
Lists
- Item one
- Item two
- Nested item
1. First
2. Second
3. Third
Task lists
- [x] Completed task
- [ ] Pending task
Blockquotes
> This is a blockquote.
> It can span multiple lines.
Alerts
Use GitHub-style alerts to highlight important information. Start
a blockquote with [!TYPE] where TYPE is one of NOTE, TIP,
IMPORTANT, WARNING, or CAUTION:
> [!NOTE]
> Useful background information.
Here's what each type looks like:
Note
Useful background information the reader should be aware of.
Tip
Helpful advice for getting the most out of something.
Important
Key information users need to know to achieve their goal.
Warning
Urgent information that needs immediate attention to avoid problems.
Caution
Warns about risks or negative outcomes of an action.
Button links
You can make any link render as a button by adding {button}
after it:
[Get started](https://example.com){button}
[Learn more](https://example.com){button-outline}
[Delete this](https://example.com){button-danger}
Three styles are available:
| Syntax | Style |
|---|---|
{button} |
Primary (filled, blue) |
{button-outline} |
Outline (bordered) |
{button-danger} |
Danger (filled, red) |
Here's what they look like:
Primary button Outline button Danger button
Code blocks
Use triple backticks with an optional language name for syntax highlighting. Each code block has a copy button in the top corner — click it to copy the contents to your clipboard.
```python
def hello():
print("Hello, world!")
```
Tables
| Column A | Column B |
|----------|----------|
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
Horizontal rules
---
Uploading files
You can upload files (images, PDFs, documents, etc.) directly into the editor. There are three ways to upload:
- Toolbar button — Click the upload icon in the editor toolbar to open a file picker
- Paste — Paste an image from your clipboard directly into the editor
- Drag and drop — Drag a file from your computer onto the editor
The file is uploaded and the appropriate Markdown syntax is inserted
automatically —  for images and [filename](url) for
other files.
File size limit: The maximum upload size is 1 GB per file.
Blocked file types: Executable files (.exe, .sh, .bat,
.js, .dll, and similar) cannot be uploaded for security reasons.
Privacy: Uploaded files are served through signed URLs. Files attached to a private page are only accessible to users who have permission to view that page.
The editor
The Markdown editor has a toolbar with buttons for common formatting (bold, italic, headings, lists, quotes, links, images, tables, and file upload). Below the toolbar are Write and Preview tabs — click Preview to see the rendered page without saving.
A status bar at the bottom of the editor shows the current line and word count.
If you navigate away from the page with unsaved changes, the browser will warn you before leaving.
mike