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)
![Alt text](/files/123/image.png)

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:

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

Lead paragraph

You can style the opening paragraph of a page as a lead — a larger, bolder introduction that sets the tone before the body content begins. Wrap it in a <p> tag with the lead class as the very first thing in the page content:

<p class="lead">
This is the opening summary of the page. It appears larger
and bolder than the rest of the content.
</p>

The lead styling only applies when it is the first element on the page. A <p class="lead"> placed anywhere else will render as a normal paragraph.

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!")
```

Tabbed code blocks

To show the same example in several languages, wrap ordinary code fences in {% tabs %} and {% endtabs %} markers. Each fence becomes a tab, labeled by its language. Use ```curl for a cURL tab — it highlights as shell but gets a cURL label.

{% tabs %}

```curl
curl https://example.com/api/
```

```python
import requests
requests.get("https://example.com/api/")
```

{% endtabs %}

Picking a tab switches every tab group on the page to that language, and the wiki remembers your choice on future pages. Only code fences may appear between the markers — anything else leaves the group unconverted so you can spot the mistake.

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 — ![alt](url) for images and [filename](url) for other files.

File size limit*: Images can be up to *20 MB*. Other files can be up to *1 GB.

Blocked file types: Executable files (.exe, .sh, .bat, .js, .dll, and similar) cannot be uploaded for security reasons.

Privacy: Image metadata (EXIF data such as GPS coordinates, camera model, and timestamps) is automatically stripped before upload so it never reaches the server. 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.

Image optimization: Uploaded images (JPEG, PNG, WebP) are automatically optimized in the background to reduce file sizes without noticeable quality loss. The original file is kept if optimization would make it larger.

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.