Write content
How-toOne Markdown file per article, one folder per group.
Add an article
Section titled “Add an article”Create src/content/docs/docs/<group>/<slug>.md:
---title: Restore a backupdescription: Restore a backup to production or staging.intro: Restore any backup in a few steps.type: how-tosidebar: 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.
Add a group
Section titled “Add a group”- Add the group to
groupsinsrc/config/docs.config.tsand to a tab. See Tabs and groups. - Create
src/content/docs/docs/<id>/index.mdx:
---title: Billingdescription: Plans, invoices and payment.intro: Plans, invoices and payment.type: overviewsidebar: 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.
Callouts, tabs and code
Section titled “Callouts, tabs and code”Use Starlight’s components (asides, tabs, code blocks); they are styled by the same theme. Rename an article to .mdx to import components.
Was this helpful?