Markdown 示例
这一页展示常用的 Markdown 写法。你可以直接复制片段，用在自己的说明文档、教程或产品手册里。
标题与段落
标题负责分层，段落负责讲清楚一件事。好的文档不需要每句话都很长，但需要让读者知道下一步往哪里走。
列表
无序列表
- 明确目标
- 拆分步骤
- 给出示例
- 留下检查项
任务列表
- [x] 初始化站点
- [x] 调整中文导航
- [x] 美化主题样式
- [ ] 写入真实业务内容
表格
| 场景 | 建议写法 | 说明 |
|---|---|---|
| 快速说明 | 三到五行概括 | 适合首页和概览 |
| 操作教程 | 步骤加代码块 | 适合安装、部署、配置 |
| 方案比较 | 表格呈现 | 适合对比功能和成本 |
提示块
信息
用于补充背景，不抢正文的重点。
建议
用于放置经验、快捷方式或推荐做法。
注意
用于提醒可能出错的地方。
风险
用于说明不可逆操作、权限风险或生产环境影响。
展开更多
这里可以放折叠内容，例如较长的排查步骤、备用方案或背景材料。
代码块
ts
type Note = {
title: string
tags: string[]
updatedAt: string
}
const note: Note = {
title: '写一份清楚的中文文档',
tags: ['docs', 'vitepress', '中文'],
updatedAt: '2026-05-18'
}代码分组
bash
npm run devbash
npm run buildbash
npm run preview引用
文档不是把所有内容塞进去，而是把读者真正需要的信息排好顺序。