Callouts make important information stand out from the text around it. They use the same syntax as GitHub.
Write a callout
Start a quote with a marker on its own line, then write the content on the lines below it:
> [!NOTE]
> Drafts are only visible in the editor.
The result:
Note
Drafts are only visible in the editor.
The five types
| Marker | Use it for |
|---|---|
[!NOTE] |
Useful information readers should know, even when skimming |
[!TIP] |
Advice that helps readers work better or faster |
[!IMPORTANT] |
Information readers need to succeed |
[!WARNING] |
Something that needs attention to avoid problems |
[!CAUTION] |
Risks or negative outcomes of an action |
Tip
Press / on any page to jump to search.
Important
A page is visible only when its parent pages are published too.
Warning
Renaming a slug changes the page address. The old address redirects, but update links in other sites when you can.
Caution
Keep provisioning API keys secret. Anyone with a key can create and delete sites.
What can go inside
A callout can hold several paragraphs, lists, links and code blocks. Start every line with >:
> [!TIP]
> Check your Go version first:
>
> ```bash
> go version
> ```
Rules
- The marker must be alone on the first line.
> [!NOTE] Texton one line stays a normal quote. - Markers are not case-sensitive, so
[!note]works too. - Any other marker, such as
[!DANGER], stays a normal quote. - The title (Note, Tip and so on) is real text, so screen readers and printed pages include it.
Use callouts sparingly: when every paragraph is highlighted, nothing stands out.