Warden

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 read a little softer than a plain quote, and they come in several tones:

Note

A note container suits context you would like readers to notice without alarm.

WARNING

A warning container fits the rare moment when a detail could really trip someone up.

DANGER

A danger container is reserved for the few cases where a mistake 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, which keeps supporting detail close by without crowding the main thread.

Small inline labels help with versions or status v1.0+. Always pair it with a closing tag, since <Badge .../> would swallow the rest of the paragraph.

Code blocks

A code block can take a title, highlight a line, and number its lines:

md
```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:

md
![A quiet caption for your image.](/assets/example.webp)

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:

md
::: gallery
![](/assets/one.webp)
![](/assets/two.webp)
![](/assets/three.webp)
:::

Maps

To place points on a map, use a map block. Each pin needs coords and can carry 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 picks up the explanation:

md
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 Protocol

The 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 keep paired ideas tidy:

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.

And when a thought needs a source, a footnote tucks it out of the way.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"}.


  1. Footnotes render at the bottom of the page with a link back to where you were reading.