Jamdesk Documentation logo

部署工作流

了解 Jamdesk 如何通过 GitHub 推送或 CLI 自动部署,并跟踪状态、手动重新构建、查看构建日志及回滚。

Jamdesk 会自动处理部署。将更改推送到已连接的 GitHub 分支后,您的文档将在几分钟内上线。

CLI 部署

您也可以直接从终端部署,而无需推送到 GitHub。这适用于快速迭代、测试更改或未连接代码仓库的项目。

jamdesk login     # First time only
jamdesk deploy

CLI 会打包文件、上传文件,并实时显示构建进度。使用 --detach 可将构建加入队列并立即退出。

CLI 部署指南

完整的流水线演练、构建阶段、错误参考和故障排除

工作流

1
在本地进行更改

编辑 MDX 文件,并使用 jamdesk dev 进行预览。

2
推送到 GitHub

提交更改并推送到已连接的分支:

git add .
git commit -m "Update authentication docs"
git push
3
自动部署

Jamdesk 会检测您的推送,构建文档,并将其部署到 CDN。大多数网站会在 30–90 秒内完成构建。

部署状态

在仪表板的 Deployments 下查看状态:

状态含义
Building正在构建
Deployed已在您的域名上线
Failed构建错误 — 请检查日志
Queued等待上一个构建完成

手动重新构建

无需推送即可触发重新构建:

  1. 在项目中打开 Settings
  2. 点击 Rebuild

在更新环境变量或修复卡住的构建时,可以使用此功能。

构建日志

构建失败时,请打开 Deployments → 点击某个部署 → 查看日志。常见问题包括:

  • 无效的 MDX 语法
  • 缺少图像
  • 损坏的内部链接
  • 配置错误

回滚

恢复到之前的版本:

  1. 打开 Deployments
  2. 找到要恢复的部署
  3. 点击 Rollback

之前的版本会立即上线。

后续步骤

CLI 部署

无需推送到 GitHub,直接从终端部署

构建与部署生命周期

详细的构建流程、触发条件和环境变量说明

自定义域名

设置 docs.yourdomain.com

CLI 概览

本地工具和命令

本地预览

推送前预览文档