Jamdesk Documentation logo

部署工作流

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

推送到已连接的 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 概览

本地工具和命令

本地预览

推送前预览文档