Docs
Docs 是独立的 VitePress 静态文档应用,构建产物由 Nginx 提供服务。
构建与运行
text
Node 22 + pnpm
→ 安装 @markify/docs 依赖
→ vitepress build
→ 静态 dist
→ Nginx Alpine运行镜像不包含 Node.js、pnpm、源码或其他服务依赖。
网络边界
- 容器名:
markify-docs - Compose 服务名:
docs - 内部端口:
80 - 网络:仅
wangquan-network - 健康检查:
GET /health
Docs 不需要访问 markify-internal,也不代理 API。生产环境由现有网关为 API 和文档配置独立域名或路径。
缓存策略
- VitePress 指纹静态资源使用长期不可变缓存。
- HTML 使用短缓存/重新验证,便于发布后及时更新。
- 开启 gzip 与基础安全响应头。
内容来源
公开文档以当前源码和 contracts/*.openapi.yaml 为事实来源。仓库根 docs/plans 和 docs/archive 是实施记录,不应直接视为当前公开协议。