Markdown Reference
Your pages are Markdown, with more on top of the basics. This page is the syntax reference. For the fields that go above the content, see Front Matter.
Callout containers
Callouts stand out more than a simple quote and come in several tones:
Note
A note container is for context readers should notice.
WARNING
A warning container is for a detail that could trip someone up.
DANGER
A danger container is for a mistake that is costly.
You can fold a longer aside behind a summary to keep the page scannable:
A longer aside, folded away
Content inside a details container stays hidden until a reader opens it.
Small inline labels help with versions or status <Badge .../> would swallow the rest of the paragraph.
Code blocks
A code block can take a title, highlight a line, and number its lines:
```csharp:line-numbers {3} [Program.cs]
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
app.MapGet("/", () => "Hello from Warden"); // this line is highlighted
app.Run();
```Images
The alt text becomes a caption below the image, and a few attributes set the size:
{.natural}keeps the original size, and{.plain}drops the frame{.left}and{.right}float the image beside your text{.wide}reaches a little past the reading column{.full}spans the whole viewport
A page's cover in front matter accepts the same width attributes.
For a row of images side by side, wrap them in a gallery:
::: gallery



:::Maps
To place points on a map, use a map block. Each pin needs coords and can have a name, a phone number, a contact address, a website, and a line of text. The pins show as markers, and a click opens their details:
Leave zoom and center out and the map frames every pin for you. Maps use OpenStreetMap tiles, which load from OpenStreetMap when a reader opens the page.
Abbreviations
Define a term once and every mention of it on the page gets the explanation:
The HTML spec is written by the WHATWG and rendered here over HTTP.
*[HTML]: HyperText Markup Language
*[WHATWG]: Web Hypertext Application Technology Working Group
*[HTTP]: HyperText Transfer ProtocolThe HTML (HyperText Markup Language) spec is written by the WHATWG (Web Hypertext Application Technology Working Group) and rendered here over HTTP (HyperText Transfer Protocol).
Definitions can sit anywhere in the file, so most writers keep them at the bottom with the footnotes. Terms show up with a dotted underline. On a desktop the explanation appears when you hover; on a phone, tap the term and it appears just above it.
Definition lists, footnotes, and links
Definition lists:
- Status page
- The live root page, rendered from what Warden has checked.
- Incident report
- A hand-written page under
content/incidents/, linked to a monitor by id.
Footnotes work too.1
External links can open in a new tab with a small attribute, as standardized in the Markdig reference, written as {target="_blank" rel="noopener"}.
-
Footnotes render at the bottom of the page with a link back to where you were reading.↩