我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

排查 GitHub Pages 站点的 Jekyll 构建错误

您可以使用 Jekyll 构建错误消息来排查 GitHub Pages 站点的问题。

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。 更多信息请参阅“GitHub 的产品”。

本文内容

Did this doc help you?

排查构建错误

如果在本地或 GitHub 上构建 GitHub Pages 站点时发生 Jekyll 错误,您可以使用错误消息排查故障。 有关构建错误以及如何查看它们的更多信息,请参阅“关于 GitHub Pages 站点的 Jekyll 构建错误”。

如果您收到一般错误消息,请检查常见问题。

  • 您使用的插件不受支持。 更多信息请参阅“关于 GitHub Pages 和 Jekyll”。
  • 您的仓库已超过我们的仓库大小限制。 更多信息请参阅“我的磁盘配额是多少?
  • 您更改了 _config.yml 文件中的 source 设置。 GitHub Pages 在构建过程中会覆盖此设置。
  • 发布源中的文件名包含不受支持的冒号 (:)。

如果您收到特定的错误消息,请查看下面的错误消息疑难解答信息。

修复任何错误后,请将更改推送到站点的发布源,以触发 GitHub 上的再次构建。

Config 文件错误

此错误意味着 _config.yml 文件包含语法错误导致您的站点无法构建。

要排除故障,请确保 _config.yml 文件遵循以下规则:

  • 使用空格代替制表符。
  • 对每个键值对在 : 后包含一个空格,如 timezone: Africa/Nairobi
  • 仅使用 UTF-8 字符。
  • 引用 : 等特殊字符,如 title: "my awesome site: an adventure in parse errors"
  • 对于多行值,请使用 | 创建换行符,使用 > 忽略换行符。

为识别任何错误,可以将 YAML 文件的内容复制并粘贴到 YAML 语法检查,如 YAML 验证器

日期不是有效的日期时间

此错误意味着站点上的某个页面包含无效的日期时间。

要排除故障,请搜索错误消息中的文件和文件布局,以调用任何与日期相关的 Liquid 过滤器。 确保在所有情况下传递给日期相关 Liquid 过滤器的任何变量都有值,并且永远不会传递 nil""。 更多信息请参阅 Liquid 文档中的“Liquid 过滤器”。

文件在包含目录中不存在

此错误意味着您的代码引用了 _includes 目录中不存在的文件。

要进行故障排除,请在 include 的错误消息中搜索文件,以查看您在哪些地方引用了其他文件, 例如 {% include example_header.html %}。 如果您引用的任何文件不在 _includes 目录中,请将这些文件复制或移动到 _includes 目录中。

此错误意味着您的代码引用了站点发布源中不存在的符号链接文件。

要进行故障排除,请在 include 的错误消息中搜索文件,以查看您在哪些地方引用了其他文件, 例如 {% include example_header.html %}。 如果您引用的任何文件是符号链接的文件,请将这些文件复制或移动到 _includes 目录中。

文件未采用正确的 UTF-8 编码

此错误意味着您使用了非拉丁字符(如 日本語)但没有告诉计算机预期这些符号。

要排除故障,请将以下行添加到 _config.yml 文件以实施 UTF-8 编码:

encoding: UTF-8

高亮插件语言无效

此错误意味着您在配置文件中指定了 RougePygments 以外的任何语法高亮插件。

要排除故障,请更新 _config.yml 文件以指定 RougePygments。 更多信息请参阅“关于 GitHub 和 Jekyll”。

帖子日期无效

此错误意味着站点上的帖子在文件名或 YAML 前页中包含无效的日期。

要排除故障,请确保所有日期的 UTC 格式均为 YYYY-MM-DD HH:MM:SS, 并且都是实际日历日期。 要指定与 UTC 偏移的时区,请使用格式 YYYY-MM-DD HH:MM:SS +/-TTTT,例如 2014-04-18 11:30:00 +0800

如果您在 _config.yml 文件中指定日期格式,请确保格式正确。

Sass 或 SCSS 无效

此错误意味着您的仓库包含内容无效的 Sass 或 SCSS 文件。

要排除故障,请查看指示 Sass 或 SCSS 无效的错误消息中包含的行号。 为防止以后出错,请在您的常用文本编辑器中安装 Sass 或 SCSS 语法检查插件。

子模块无效

此错误意味着您的仓库包含尚未正确初始化的子模块。

要排除故障,请先决定您是否真的想要使用子模块,它是 Git 项目内的 Git 项目; 子模块有时是意外创建的。

如果不想使用子模块,请删除子模块,用子模块的路径替换 PATH TO-SUBMODULE

$ git submodule deinit PATH-TO-SUBMODULE
$ git rm PATH-TO-SUBMODULE
$ git commit -m "Remove submodule"
$ rm -rf .git/modules/PATH-TO-SUBMODULE

如果要使用子模块,请确保在引用子模块时使用 https://(而不是 http://),并确保该子模块在公共仓库中。

数据文件中的 YAML 无效

此错误意味着 _data 文件夹中的一个或多个文件包含无效的 YAML。

要排除故障,请确保 _data 文件夹中的 YAML 文件遵循以下规则:

  • 使用空格代替制表符。
  • 对每个键值对在 : 后包含一个空格,如 timezone: Africa/Nairobi
  • 仅使用 UTF-8 字符。
  • 引用 : 等特殊字符,如 title: "my awesome site: an adventure in parse errors"
  • 对于多行值,请使用 | 创建换行符,使用 > 忽略换行符。

为识别任何错误,可以将 YAML 文件的内容复制并粘贴到 YAML 语法检查,如 YAML 验证器

有关 Jekyll 数据文件的更多信息,请参阅 Jekyll 文档中的“数据文件”。

Markdown 错误

此错误意味着您的仓库包含 Markdown 错误。

要排除故障,请确保使用受支持的 Markdown 处理器。 更多信息请参阅“使用 Jekyll 为 GitHub Pages 站点设置 Markdown 处理器”。

然后,确认错误消息中的文件使用有效的 Markdown 语法。 更多信息请参阅 Daring Fireball 上的“Markdown:语法”。

缺少 docs 文件夹

This error means that you have chosen the docs folder on a branch as your publishing source, but there is no docs folder in the root of your repository on that branch.

To troubleshoot, if your docs folder was accidentally moved, try moving the docs folder back to the root of your repository on the branch you chose for your publishing source. 如果 docs 文件夹被意外删除,您执行以下任一操作:

  • 使用 Git 还原或撤消删除。 更多信息请参阅 Git 文档中的“git-revert”。
  • Create a new docs folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. 更多信息请参阅“创建新文件”。
  • 更改发布源。 更多信息请参阅“配置 GitHub Pages 的发布源”。

缺少子模块

此错误意味着您的仓库包含不存在或尚未正确初始化的子模块。

要排除故障,请先决定您是否真的想要使用子模块,它是 Git 项目内的 Git 项目; 子模块有时是意外创建的。

如果不想使用子模块,请删除子模块,用子模块的路径替换 PATH TO-SUBMODULE

$ git submodule deinit PATH-TO-SUBMODULE
$ git rm PATH-TO-SUBMODULE
$ git commit -m "Remove submodule"
$ rm -rf .git/modules/PATH-TO-SUBMODULE

如果要使用子模块,请初始化子模块。 更多信息请参阅 Pro Git 手册中的“Git 工具 - 子模块”。

此错误意味着您的 _config.yml 文件中存在 GitHub Pages 不支持的相对永久链接。

永久链接是引用站点上特定页面的永久 URL。 绝对永久链接以站点的根目录开头,而相对永久链接以包含引用页面的文件夹开头。 GitHub Pages 和 Jekyll 不再支持相对永久链接。 有关永久链接的更多信息,请参阅 Jekyll 文档中的“永久链接”。

要排除故障,请从 _config.yml 文件中删除 relative_permalinks 行,并将站点中的任何相对永久链接重新格式化为绝对永久链接。 更多信息请参阅“编辑仓库中的文件”。

此错误意味着您的站点包含站点发布源中不存在的符号链接。 有关符号链接的更多信息,请参阅维基百科上的“符号链接”。

要排除故障,请确定错误消息中的文件是否用于构建站点。 如果否,或者您不希望文件成为符号链接,请删除该文件。 如果符号链接文件是构建站点的必需项,请确保符号链接引用的文件或目录存在于站点的发布源中。 要包括外部资产,请考虑使用 git submodule 或第三方包管理器,例如 Bower。 更多信息请参阅“将子模块用于 GitHub Pages。”

'for' 循环中的语法错误

此错误意味着您的代码在 Liquid for 循环声明中包含无效语法。

要排除故障,请确保错误消息所指文件中的所有 for 循环都具有正确的语法。 有关 for 循环之正确语法的更多信息,请参阅 Liquid 文档中的“迭代标记”。

标记未正确关闭

此错误消息意味着您的代码包含未正确关闭的逻辑标记。 例如,{% capture example_variable %} 必须用 {% endcapture %} 关闭。

要排除故障,请确保错误消息所指文件中的所有逻辑标记都正确关闭。 更多信息请参阅 Liquid 文档中的“Liquid 标记”。

标记未正确终止

此错误意味着您的代码包含未正确终止的输出标记。 例如,用 {{ page.title } 代替 {{ page.title }}

要排除故障,请确保错误消息所指文件中的所有输出标记都用 }} 终止。 更多信息请参阅 Liquid 文档中的“Liquid 对象”。

未知标记错误

此错误意味着您的代码包含无法识别的 Liquid 标记。

要排除故障,请确保错误消息所指文件中的所有 Liquid 标记都与 Jekyll 的默认变量相匹配,并且标记名称没有拼写错误。 有关默认变量列表,请参阅 Jekyll 文档中的“变量”。

不受支持的插件是无法识别标记的常见来源。 如果您通过在本地生成站点并将静态文件推送到 GitHub 的方法在站点中使用不受支持的插件,请确保该插件未引入 Jekyll 默认变量中没有的标记。 有关受支持插件的列表,请参阅“关于 GitHub Pages 和 Jekyll”。

Did this doc help you?