Writing Markdown

The docs site uses VitePress. Pages are .md files, and the directory structure maps to public routes.

Create a page

Create a Markdown file in the appropriate directory:

player/
└─ example-guide.md

Minimum page structure:

---
title: Page title
description: One sentence describing the page.
---

# Page title

Page content.

Supported content

• Headings, lists, tables, and task lists
• Language-aware code blocks and line numbers
• Internal links and images
• tip, warning, and danger containers
• YAML frontmatter

注意

After adding a page, add it to the matching locale sidebar in .vitepress/config.mts and run pnpm build to check links.