静态导出处于私有 Beta 阶段,需要企业协议。请联系 sales@mintlify.com 了解详情。
静态包中的页面 URL
.html URL。例如,/guides/getting-started 会变为 /guides/getting-started.html。此行为自动生效,无需任何配置。
canonical 和 sitemap 中的 URL 仍保持无扩展名。CloudFront 会自动解析这些 URL,但其他静态托管服务可能需要配置重写规则。
静态导出的工作原理
1
启动静态导出作业
使用你的项目 ID 调用 启动静态导出作业。API 会将作业加入队列并返回
jobId。每个部署同一时间只能有一个处于活动状态的作业。如果该部署已有作业处于 queued 或 running 状态,端点将返回 409。该端点的速率限制为每个组织每小时最多启动 10 个作业。2
轮询作业并下载包
使用
jobId 轮询 获取静态导出作业状态,直到 status 为 completed。完成后的响应中会包含 bundleUrl(指向该包的有时限预签名 S3 链接)、sizeBytes 以及 expiresAt 时间戳。请在 expiresAt 之前下载该包。过期后,可再次调用状态端点以获取新的 bundleUrl,底层的导出文件仍可复用,仅链接有时限。按部署方式的功能支持
端点
- 启动静态导出作业:为项目将一个静态导出作业加入队列。
- 获取静态导出作业状态:轮询作业状态;作业完成后,获取该包的预签名下载链接。
身份认证
mint_ 前缀开头,属于服务端机密——切勿在客户端代码中暴露。
从同一页面复制你的项目 ID,并将其用作 projectId 路径参数。
将包部署到你的 Enterprise Helm chart
mintlify/enterprise 仓库中的 Helm chart 部署。当静态导出作业完成后,将 chart 指向 bundleUrl,部署环境便会从你自己的基础设施提供服务。
1
将包引用添加到 values 文件
将
values.yaml 中的静态导出字段设置为 获取静态导出作业状态 返回的 bundleUrl。chart 会在启动时获取该包并将其作为当前版本提供服务。values.yaml
2
发布 chart
使用
helm upgrade 应用更新后的 values。部署环境会下载该包,将其切换为当前站点,并从你的集群中提供服务。使用 GitHub Action 自动化
bundleUrl 应用到 Helm chart。
.github/workflows/static-export.yml
MINTLIFY_ADMIN_KEY 仓库机密,并将 PROJECT_ID 设置为你项目的 ID。在部署之前,请配置集群凭据,例如使用 azure/setup-helm 和你的 Kubernetes 配置文件(kubeconfig)。