Skip to content

编写 Markdown

文档站使用 VitePress。页面以 .md 文件保存,目录结构会映射为访问路径。

新建页面

在合适的目录新建 Markdown 文件:

text
player/
└─ example-guide.md

最小页面格式:

md
---
title: 页面标题
description: 用一句话说明页面用途。
---

# 页面标题

正文内容。

支持的内容

  • 标题、列表、表格和任务列表
  • 带语言标识的代码块与行号
  • 内部链接和图片
  • tipwarningdanger 等提示块
  • YAML Frontmatter

注意

新增页面后,请同时把入口加入 .vitepress/config.mts 的对应语言侧边栏,并运行 pnpm build 检查死链。

中英文目录

中文是根目录内容;英文页面放在 en/ 下,并保持相同的信息层级。

由 Project Rebound 社区维护