Jamdesk Documentation logo

首次构建

连接仓库后会发生什么:构建阶段、Deployments 选项卡,以及失败时的检查项。

连接仓库后,首次构建会自动开始。

自动构建

连接仓库后,Jamdesk 会立即触发初始构建。之后,您每次向已连接的分支推送内容,都会自动触发新的构建。

构建进度

在仪表板中跟踪构建进度:

1
排队中

您的构建正在等待开始。在高峰时段,可能需要短暂排队。

2
克隆中

Jamdesk 正在从 GitHub 获取您的仓库内容。

3
验证中

系统正在检查您的 docs.json 和 MDX 文件是否存在错误。

4
构建中

MDX 正在编译为经过优化的 HTML,并生成语法高亮和搜索索引。

5
部署中

构建后的文件正在上传到全球 CDN。

6
已上线

您的文档已可通过项目 URL 访问。

查看已上线的文档

构建完成后,在仪表板中点击 View Site,或访问 https://your-project.jamdesk.app

如果您配置了自定义域名,也可以通过该域名访问文档。

手动重新构建

需要在不推送更改的情况下重新构建?

  1. 仪表板 中打开您的项目
  2. 打开 Settings
  3. 点击 Rebuild

更改环境变量后,或需要强制执行全新构建时,可以使用此功能。

构建失败时

构建失败时,仪表板中会显示错误消息。常见原因包括:

  • docs.json 语法无效
  • MDX 语法错误
  • 导航中引用的页面缺失
构建错误参考

查看常见错误代码及其修复方法

相关文章

触发构建

了解自动和手动构建触发方式

监控构建

跟踪构建进度并查看日志