Pages

Every page is one .mdx file under content/docs/. MDX is Markdown plus the components on this site, so you can write prose and drop in cards, steps, or callouts in the same file.

Frontmatter

Each page starts with a small header — the "frontmatter" — between --- fences:

---
title: Webhooks
description: Getting notified when things happen
---

Page content, in Markdown.

• title appears in the sidebar, the browser tab, and search results.
• description appears under the page title and in link previews.

Markdown basics

Standard Markdown works as you'd expect — headings, bold, italic, inline code, lists, quotes, and tables:

## A heading

- A bullet
- Another bullet

> A quote

| Column | Column |
| --- | --- |
| Cell | Cell |

Headings become anchor links automatically and populate the on-page table of contents.

Links between pages

Link to another page with its site path, starting from the root:

See the [Quickstart](/example/guides/get-started/quickstart) to begin.

Internal links are checked at build time — a link to a page that doesn't exist is easy to spot because the build surfaces it.

Images

Put images in public/ and reference them with an absolute path:

![Architecture diagram](/images/architecture.png)

Images are responsive and lazy-loaded. For diagrams you can also use Mermaid instead of a static image, so they restyle for light and dark mode.