Structure

How files and folders become navigation and URLs

The mental model

Your site is organised around products — the top-level sections readers switch between in the header. Each product has written guides and, optionally, a generated API reference:

/                                    home page (built from docs.json)
/{product}/guides/...                your Markdown pages
/{product}/api-reference/...         generated from your OpenAPI file

This template ships one product with the id example, which is why every URL here starts with /example/. Rename it (or add more) in docs.json:

"products": [
  { "id": "platform", "label": "Platform" },
  { "id": "mobile", "label": "Mobile SDK" }
]

Each product id maps to a folder: content/docs/{product-id}/guides/.

Pages

A page is one .mdx file with a small header (the "frontmatter"):

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

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

Every folder of pages has a meta.json that names the folder and orders its pages:

{
  "title": "Guides",
  "pages": ["index", "quickstart", "structure", "components"]
}

Sub-folders work the same way — put pages in a folder with its own meta.json and it becomes a collapsible sidebar group.

What you get without configuring anything

Built inDetails
SearchFull-text, across every page — press ⌘K.
Dark modeAutomatic, with a toggle in the header. Your brand colors adapt.
MobileThe whole site, including menus, works on phones.
AI-readable output/llms.txt and per-page Markdown endpoints, so AI tools can read your docs.
Link previewsSocial/OG images generated per page.
Safety railsThe build fails loudly on a broken docs.json or API file — errors never reach readers.