配置文档中心各处文案。标题类默认取「系统设置-网站标题」,可在此覆盖。
生效说明(重要)
| 文案位置 | 修改后是否立即生效 | 说明 |
| 对外文档总列表页(/api/doc/index) | ✓ 实时生效 | PHP 实时渲染,保存后刷新页面即可看到 |
| 后台接口文档入口页(/admin/doc/api) | ✓ 实时生效 | 同上 |
| 接口文档站浏览器标签标题(/api-docs-site/) | ⟳ 需重新构建 | VitePress 静态站,构建时从本配置读取注入。改完需在服务器执行构建命令 |
重新构建接口文档站操作步骤(在本地开发机执行,服务器无 node 环境):
1. 本地进入文档目录:cd docs/api-docs
2. 安装依赖(首次或依赖变更时):npm install
3. 构建(自动通过 HTTP 接口读取本页文案注入标题):npm run docs:build
构建脚本会访问 https://admin.ypsqq.com/api/doc/siteConfig 取最新文案;
若需指定其他地址:DOC_SITE_URL=https://你的域名/api/doc/siteConfig npm run docs:build
4. 提交构建产物:git add public/api-docs-site && git commit && git push
5. 服务器拉取:cd /www/wwwroot/admin.ypsqq.com/yp_admin && git pull && sudo -u www php think clear
构建产物输出到 public/api-docs-site/,通过软链 api-docs-site 对外访问。
后台接口文档入口页(/admin/doc/api)
入口页标题与「API 文档卡片标题」共用。