故障排除

我遇到了 GitHub 同步错误

请确保只在你的仓库中创建 README 文件

启用 Git 同步时,请注意不要通过 GitBook UI 创建 README 文件。通过 GitBook UI 创建 README 文件会:

  • 在你的仓库中创建重复的 README 文件

  • 导致 GitBook 与 GitHub 之间的渲染冲突

  • 可能破坏构建和部署流程

  • 导致不可预测的文件优先级

这包括名为 README.md、readme.md、Readme.md 和不带扩展名的 README 的文件。相反,请记得直接在你的 git 仓库中管理你的 README 文件。

仍然遇到错误?

请确保:

GitBook 没有使用我的 docs 文件夹

默认情况下,GitBook 使用仓库根目录作为起点。可以指定特定目录以限定 Markdown 文件。有关更多信息,请查看我们的 如果你的 Markdown 文件中有 YAML frontmatter,请使用 文档。

GitBook 正在创建新的 Markdown 文件

当从 GitBook 与已有的 Git 仓库同步并编辑时, GitBook 可能会创建新的 Markdown 文件而不是使用已有文件。这么做是为了确保 GitBook 不会覆盖在你仓库中已有的文件。

重定向无法正确工作

YAML 文件需要正确格式化,重定向才能生效。诸如缩进或空格错误可能导致重定向无法工作。 验证你的 YAML 文件 可以确保重定向顺利工作。

设置重定向时,不要添加任何前导斜杠。例如,尝试重定向到 ./misc/support.md 将无法工作。

还需要注意的是,只要某个路径对应的页面存在,GitBook 就不会去查找可能的重定向。因此,如果你为旧页面设置重定向到新页面,需要删除旧页面,重定向才能生效。

我的仓库未列出

针对 GitHub 仓库

请确保你已将 GitBook GitHub 应用安装到正确的位置(安装应用时,你可以选择安装到个人 GitHub,或安装到你有权限的任何组织),并且已授予该应用正确的仓库权限。

针对 GitLab 仓库

请确保你的访问令牌已配置以下访问权限:

  • api

  • read_repository

  • write_repository

在将新文件添加到我的仓库后,GitBook 没有任何反应

如果在通过向仓库添加或修改 Markdown 文件更新仓库后,你没有在 GitBook 上看到更新,且侧边栏在同步期间未显示错误,你修改的文件可能没有被列在 你的 SUMMARY.md 文件查找文件。

这可能是因为你手动创建了该文件,或者因为你在 GitBook 上进行了编辑,而同步的 GitBook 到 Git 导出阶段为你创建了它。

该文件的内容镜像你在 GitBook 上的 目录(Table of Contents) ,并在同步的 Git 到 GitBook 导入阶段用于重建你的目录并将仓库中即将到来的更新与 GitBook 上现有内容重新对齐。

如果在确认所有文件都包含在 SUMMARY.md 文件中后,GitBook 仍然没有任何反应,请随时 联系支持 寻求帮助。

GitHub 预览未显示

如果你的 GitHub 预览未显示,可能是因为你的 GitSync 集成是在 2022 年 1 月之前配置的。该日期之前配置的 GitSync 版本不包含 GitHub 预览。

你应该已经收到一条通知,要求你接受更新后的权限请求以启用对 PR 的只读访问。

如果你没有收到该通知,故障排除需要更新到新版本:

  1. 从你的组织中卸载 GitSync 集成。

  2. 使用更新权限重新安装新版本。

请注意,卸载 GitSync 集成将需要在之前连接过的任何空间上重新配置该集成。

登录时可能出现重复账户

此错误通常发生在用于设置同步的 GitHub 账户已与另一个 GitBook 用户账户关联时。

识别该 GitHub 账户已链接到哪个 GitBook 账户的一个好方法是:

  1. 登出你当前的 GitBook 用户会话(例如: name@email.com)

  2. 登出任何 GitHub 用户会话。

  3. 选择“使用 GitHub 登录”选项。

  4. 输入你的 GitHub 凭据。

  5. 登录后,前往 账户设置 并执行以下操作之一:

    1. 在“第三方登录 > GitHub”部分取消关联该账户(个人设置中)

    2. 如果不需要该账户,则彻底删除该账户。

  6. 从该会话登出。

  7. 使用你的 name@email.com GitBook 账户重新登录。

  8. 尝试再次设置 Git 同步。

最后更新于

这有帮助吗?