编写文档
在 docs 目录中新建 .md 或 .mdx 文件即可增加页面。
页面元数据
docs/example.md
---
title: 示例接口
sidebar_position: 10
---
# 示例接口
这里填写正文。
title 控制页面和侧边栏名称,sidebar_position 控制排序。新页面还需要加入 sidebars.ts 才会显示在当前手工目录中。
代码块
```bash
curl https://api.example.com/v1/models
```
可以把语言改成 json、typescript、python 等,以启用语法高亮。
提示框
:::warning[注意]
这里填写需要重点说明的内容。
:::
可用类型包括 note、tip、info、warning 和 danger。
图片和下载文件
把文件放到 static 目录。例如 static/img/diagram.png 可这样引用:

路径以 / 开头,发布后会从站点根目录读取。