Jamdesk Documentation logo

构建失败

将构建错误与修复方法对应:配置错误、MDX 语法错误、文件缺失、OpenAPI 问题及超时。

在 Deployments 标签页中打开失败的构建,并将错误信息与下方某一节对应。

查找错误

  1. 进入项目的 Deployments 标签页
  2. 点击失败的构建
  3. 查看错误信息和日志

日志会显示失败的内容及其位置。

常见失败原因

配置无效

错误: "Invalid docs.json"

你的 docs.json 存在语法或结构错误。

修复:

  1. 检查是否缺少逗号、括号或引号
  2. 在本地运行 jamdesk validate
  3. 对照 schema 参考

页面缺失

错误: "Page 'path/to/page' not found"

导航中的某个页面不存在。

修复:

  • 确认文件存在
  • 检查路径是否完全一致(区分大小写)
  • 在 docs.json 中不要包含 .mdx 扩展名

MDX 语法错误

错误: "MDX compilation failed"

MDX 或 JSX 语法无效。

常见原因:

  • 标签未闭合:<Card> 缺少 </Card>
  • 未转义的花括号:应使用 \{ 而不是 {
  • 属性无效:应使用 title="value" 而不是 title=value

图片缺失

错误: "Asset not found"

MDX 中引用的图片不存在。

修复:

  • 检查图片路径是否正确
  • 路径相对于你的文档目录
  • 确认该文件已提交到 Git

调试步骤

1
阅读错误

在日志中找到失败的内容及其位置。

2
在本地测试

运行 jamdesk dev 复现错误。

3
验证配置

运行 jamdesk validate 检查你的配置。

4
检查最近的更改

查看你最近一次提交中是否存在该问题。

仍无法解决?

如果你无法解决该问题:

  1. 复制完整的构建日志
  2. 记下你的项目 ID
  3. 联系支持

相关文章

错误参考

所有错误代码说明

CLI 概览

在本地测试构建