页面构建失败:配置文件错误
如果 GitHub 页面仓库中的 _config.yml 文件有语法错误,将无法构建 GitHub 页面站点。
如果 GitHub 页面 站点因 _config.yml 文件包含语法错误而构建失败,我们会向您发送一封如下的电子邮件:
主题:页面构建失败
页面构建因以下错误而失败:
_config.yml
文件的第 1 行有错误。
只有在 Enterprise 实例上启用了出站电子邮件支持时,您才会收到电子邮件。有关详细信息,请联系您的站点管理员。
_config.yml 语法错误疑难排解
提示:我们强烈建议本地运行 Jekyll,以便在推送到 您的 GitHub Enterprise Server 实例 之前能够轻松调试和修复构建错误。要详细了解故障排除选项,请参阅“GitHub Pages 构建故障排除。”
检查构建失败电子邮件引用的行上的 _config.yml 文件。 确保:
-
在文件中使用空格而非制表符。
-
您在 ":" 后面为每个键/值对加入了空格。
正确示例:
timezone: Africa/Nairobi
构建失败示例:
timezone:Africa/Nairobi
. -
只使用 UTF-8 字符。
-
引用任何特殊字符。
正确示例:
title: "my awesome site: an adventure in parse errors"
构建失败示例:
title: my awesome site: an adventure in parse errors
使用 YAML 语法检查(如 http://codebeautify.org/yaml-validator)验证 YAML 代码。 如果 _config.yml 文件发生剖析错误,请尝试复制并粘贴文件内容到此类工具以了解更多详情。
在修复 _config.yml 文件中的任何语法错误后,需要提交更改并再次推送到 GitHub 页面 仓库,以在服务器上触发另一次构建。
修复高亮错误
如果尝试在具有 Jekyll 的 GitHub 页面 站点上使用 Rouge 以外的语法高亮插件,您将会收到页面构建警告。 GitHub 页面 不支持其他高亮插件,将自动使用默认的 Rouge。 更多信息请参阅“在 GitHub 页面 上使用语法高亮插件”。
要修复页面构建警告,必须将 _config.yml 文件中的 highlighter 值改为 rouge
。
-
在 GitHub Enterprise 上,导航到仓库的主页面。
-
在仓库中,浏览到 _config.yml。
-
在文件视图的右上角,单击 打开文件编辑器。
-
找到以
highlighter:
开头的行,将值更改为rouge
。 -
在页面底部,键入简短、有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。更多信息请参阅“创建多个合作作者的提交."
-
在 commit message(提交消息)字段下方,决定要将提交添加到当前分支还是添加到新分支。如果当前分支为
master
,则应选择为提交创建新分支,然后创建拉取请求。 -
单击 Propose file change(提议文件更改)。