写作指南
本站文档使用 Markdown 编写，并支持 Frontmatter、提示块、代码高亮、数学公式等扩展语法。
Frontmatter
在文件顶部使用 YAML 声明页面元信息：
md
---
title: 页面标题
description: 页面描述（用于 SEO）
tags:
- 指南
- Markdown
---
# 正文标题常用字段：
| 字段 | 说明 |
|---|---|
title | 页面标题，会覆盖导航栏显示 |
description | 页面描述，用于搜索引擎与分享卡片 |
tags | 页面标签 |
layout | 页面布局，默认 doc，首页使用 home |
outline | 是否显示右侧目录 |
提示块
md
::: tip 提示
这是一条提示信息。
:::
::: warning 注意
这是一条警告信息。
:::
::: danger 危险
这是一条危险信息。
:::
::: info 说明
这是一条普通说明。
:::效果预览：
提示
这是一条提示信息。
注意
这是一条警告信息。
危险
这是一条危险信息。
说明
这是一条普通说明。
代码块
支持 js、ts、bash、python、json、sql 等常见语言的语法高亮，并支持显示行号与高亮指定行：
md
```js {2,4-5}
function greet(name) {
const message = `Hello, ${name}!` // 高亮行
console.log(message)
return message
}
```js
function greet(name) {
const message = `Hello, ${name}!` // 高亮行
console.log(message)
return message
}数学公式
使用 KaTeX 渲染数学公式：
md
行内公式 $E = mc^2$
块级公式：
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$表格
md
| 方法 | 路径 | 说明 |
| --- | --- | --- |
| GET | `/api/users` | 获取用户列表 |
| POST | `/api/users` | 创建用户 |
| DELETE | `/api/users/:id` | 删除用户 |图片与链接
md
[跳转到快速开始](./getting-started)组件化扩展
VitePress 支持在 Markdown 中直接使用 Vue 组件，可将复杂交互（图表、演示、Tab 等）封装为组件复用。
写作建议
- 每个文档聚焦一个主题，使用清晰的标题层级（
#→##→###）； - 代码示例务必可直接运行，并包含必要的注释；
- 使用提示块强调注意事项与边界情况；
- 关联文档之间使用相对链接互相跳转。