Markdown syntax

The macro renders standard Markdown plus GitHub-flavoured Markdown, and a few additions for Confluence. This page covers the macro. Edit with Markdown and New page use a page dialect, described in Edit with Markdown.

Standard and GitHub-flavoured Markdown

Headings, paragraphs, bold, italic and inline code
Bulleted and numbered lists, quotes and horizontal rules
Links, and URLs that turn into links on their own
Tables with column alignment
Strikethrough with ~~text~~
Task lists with - [ ] and - [x], shown as checkboxes
Footnotes with [^1]

Raw HTML is not rendered. It shows as text.

Callouts

Callouts render as Confluence panels, with Confluence's icons and colours. Use GitHub's alert syntax:

> [!NOTE]
> Deployments are frozen on Fridays.

Callout	Looks like
`[!NOTE]`	Blue info panel
`[!TIP]`	Green success panel
`[!IMPORTANT]`	Purple note panel
`[!WARNING]`	Orange warning panel
`[!CAUTION]`	Red error panel

Or use a container, which can have its own title:

:::warning[Before you start]
Back up the database first.
:::

Containers accept note, tip, important, warning and caution, and also info (note), success (tip), danger and error (caution). The Callout button in the toolbar inserts a note callout.

Put [[toc]] on its own line to add a list of links to the headings in the macro. The Table of contents button in the toolbar inserts it.

Heading links

Every heading gets a GitHub-style anchor, so [See setup](#setup) scrolls to the Setup heading in the same macro. Links to other pages open as normal.

Emoji

Write emoji as GitHub shortcodes, such as :rocket: or :white_check_mark:.

Images

Insert images from Confluence attachments with the attachment picker. To set a size, add it in the image title:

![Architecture](https://your-site.atlassian.net/wiki/download/... "width=600px height=auto")

Images are never wider than the macro. See Attachments.

Code, math and diagrams

Code blocks with syntax highlighting and a copy button
Math with $...$ and $$...$$
Mermaid diagrams in ```mermaid blocks

Dark mode

The macro follows Confluence's light or dark theme, including code colours.