写作规范
文件与链接
- 文件名用英文小写加连字符,例如
getting-started.md,避免中文文件名和空格 - 文档之间用相对链接:
[快速开始](./getting-started.md),构建时会自动转成路由链接 - 引用静态资源用绝对路径:
/logo.svg,对应docs/public/logo.svg
标题层级
每篇文档只写一个一级标题 #,其余按 ##、### 往下排。 二级标题会自动进入右侧的「本页目录」,所以标题尽量用短语。
常用片段
提示
用 ::: tip 包起来的高亮块。
注意
::: warning、::: danger、::: info、::: details 用法相同。
bash
# 代码块默认带行号(见 config.mts 里的 markdown.lineNumbers)
echo hello1
2
2