Skip to content

Write content

How-to

One Markdown file per article, one folder per group.

Create src/content/docs/docs/<group>/<slug>.md:

---
title: Restore a backup
description: Restore a backup to production or staging.
intro: Restore any backup in a few steps.
type: how-to
sidebar:
order: 3
---
Your content in Markdown.

It appears in the sidebar and on the group’s landing page. sidebar.order sorts it; articles without one sort by title. See Frontmatter for every field.

  1. Add the group to groups in src/config/docs.config.ts and to a tab. See Tabs and groups.
  2. Create src/content/docs/docs/<id>/index.mdx:
---
title: Billing
description: Plans, invoices and payment.
intro: Plans, invoices and payment.
type: overview
sidebar:
order: 0
label: Start here
---
import ArticleCards from '../../../../components/docs/ArticleCards.astro';
<ArticleCards group="billing" />

Link to other articles with their full path and a trailing slash, for example [Quick start](/docs/getting-started/quick-start/). pnpm validate:docs fails on a broken internal link.

Use Starlight’s components (asides, tabs, code blocks); they are styled by the same theme. Rename an article to .mdx to import components.