文档站说明
本站是众扬汇AI开放平台的官方文档站,用于集中发布接口说明、接入教程与排障指引,并对全站内容提供中文检索。
技术形态
- 静态站点:构建期预渲染为 HTML,产物不依赖服务端运行时,可直接由 nginx 等静态服务托管。
- Markdown 渲染:构建脚本按 Markdown 渲染为页面,图表与代码块按原样保留。
- 中文全文搜索:构建期生成站内索引,查询端按汉字单字与相邻二字(bigram)分词,避免中文无空格导致的漏检。
- 响应式布局:桌面端为导航 / 正文 / 页内目录三栏,窄屏收纳为抽屉式目录。
内容分区
| 分区 | 路径 | 内容 |
|---|---|---|
| 指南 | /guide/ | 接入教程、参数说明、常见问题 |
| API 参考 | /api/ | 各接口的路径、参数与返回结构 |
| 数据模型 | /schema/ | 公共数据结构说明 |
| 接入与说明 | /handbook/ | 接入地址、文档站说明等手写页 |
内容加工规则
- 域名口径统一:全站统一使用本平台域名
api.allyang.cn;引用第三方官方的示例地址(如 OpenAI 官方示例)时,保持其官方域名不变,不做替换。详见「接入地址与 Base URL」。 - 花括号转义:正文中出现的双花括号按字面显示处理,避免被前端模板语法消费。
- 页面映射:每页与源文档一一对应,映射关系与构建证据随交付物一并归档。
快捷键
- 打开搜索:
Ctrl/⌘+K - 关闭搜索:
Esc