如何写文档

新增一篇文档

1. 在 docs/ 下合适的目录新建 .md 文件，例如 docs/backend/api.md
2. 在 docs/.vitepress/config.mts 的 sidebar 里加上链接：

{
  text: '后端',
  items: [
    { text: 'API 规范', link: '/backend/api' }
  ]
}

常用写法

代码块

console.log('hello')

提示框

提示

这是一条提示。

注意

这是一条警告。

危险

不要在文档里写密码、密钥等敏感信息。

表格

环境	地址
测试	test.example.com
生产	example.com