跳到主要内容

为您的 GitHub Pages 站点创建自定义 404 页面

当用户尝试访问您站点上不存在的页面时,您可以显示自定义的 404 错误页面。

谁可以使用此功能?

GitHub Pages 可用于具有 GitHub Free 和 GitHub Free for organizations 的公共存储库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有存储库。有关更多信息,请参阅“GitHub 的计划”。

GitHub Pages 现在使用 GitHub Actions 执行 Jekyll 构建。当使用分支作为构建源时,如果要使用内置 Jekyll 工作流,则必须在您的存储库中启用 GitHub Actions。或者,如果 GitHub Actions 不可用或已禁用,则将 .nojekyll 文件添加到源分支的根目录将绕过 Jekyll 构建过程并直接部署内容。有关启用 GitHub Actions 的更多信息,请参阅“管理存储库的 GitHub Actions 设置”。

  1. 在 GitHub 上,导航到您站点的存储库。

  2. 导航到您站点的发布源。有关更多信息,请参阅“配置 GitHub Pages 站点的发布源”。

  3. 在文件列表上方,选择**添加文件**下拉菜单,然后单击 创建新文件.

    或者,您可以单击左侧的文件树视图中的。

    Screenshot of the main page of a repository. Above the list of files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button with a plus sign icon is also outlined in dark orange.

  4. 在文件名字段中,键入 404.html404.md

  5. 如果您将文件命名为 404.md,请将以下 YAML 前置 matter 添加到文件的开头

    ---
    permalink: /404.html
    ---
    
  6. 如果存在,请在 YAML 前置 matter 下方添加您希望在 404 页面上显示的内容。

  7. 单击**提交更改...**

  8. 在“提交消息”字段中,键入一个简短且有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。

  9. 如果您在 GitHub 上的帐户中关联了多个电子邮件地址,请单击电子邮件地址下拉菜单并选择用作 Git 作者电子邮件地址的电子邮件地址。此下拉菜单中仅显示已验证的电子邮件地址。如果您启用了电子邮件地址隐私,则“no-reply”将成为默认的提交作者电子邮件地址。有关“no-reply”电子邮件地址可能采用的确切形式的更多信息,请参阅“设置您的提交电子邮件地址”。

    Screenshot of a GitHub pull request showing a dropdown menu with options to choose the commit author email address. octocat@github.com is selected.

  10. 在提交消息字段下方,决定是否将提交添加到当前分支或新分支。如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。有关更多信息,请参阅“创建拉取请求”。

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  11. 单击**提交更改**或**建议更改**。

进一步阅读