Command Palette
Search for a command to run...

Content layout

Everything the site shows comes from one directory of Markdown. In Docker that directory is whatever you mount at /content; from source it is src/content/. The rest — routes, sidebar, search — is derived from it.

A typical tree

  • content/
    • theme.css — optional custom styling
    • 01-getting-started/
      • 01-introduction.md
      • 02-quick-start.md
    • 02-reference/
      • index.md — the section's landing page
      • api.md

This produces:

  • A sidebar with two groups, "Getting started" and "Reference".
  • Routes at /getting-started/introduction, /getting-started/quick-start, /reference (the section index), and /reference/api.
  • A search index covering every page.

The rules

  • Files become pages. reference/api.md/reference/api.
  • First-level folders become sidebar groups. Files inside them become that group's items.
  • Filenames become URLs, kebab-cased: quick-start.md/…/quick-start.
  • A folder's index.md is that section's landing page, served at the folder's URL (reference/index.md/reference).
  • Leading number prefixes like 01- set order and are stripped from the URL and title. See Ordering & titles.

What is ignored

Only .md and .markdoc files under the content directory become pages. A theme.css is picked up for styling; anything else (drafts, notes, .txt files) is simply ignored, so you can keep working files alongside your docs.

If you reference an image, put it under static/ and link it from /screenshots/… — see Screenshots.