跳至主要内容

创建 GitHub Pages 站点

您可以在新的或已有的仓库中创建 GitHub Pages 站点。

谁可以使用此功能?

GitHub Pages 在公共仓库中可使用 GitHub Free 和组织的 GitHub Free;在公共和私有仓库中可使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server。欲了解更多信息,请参阅 GitHub 的套餐

为您的站点创建仓库

您可以为站点创建一个新仓库,或选择已有仓库。

如果您希望为一个仓库创建 GitHub Pages 站点,而该仓库中并非所有文件都与站点相关,您可以为站点配置发布源。例如,您可以使用专用的分支和文件夹来存放站点源文件,或者使用自定义的 GitHub Actions 工作流来构建并部署站点源文件。

如果拥有该仓库的账户使用 GitHub Free 或面向组织的 GitHub Free,则仓库必须是公开的。

如果您想在已有仓库中创建站点,请跳转至 创建站点 部分。

  1. 在任意页面的右上角,选择,然后点击 新建仓库

    Screenshot of a GitHub dropdown menu showing options to create new items. The menu item "New repository" is outlined in dark orange.

  2. 使用 Owner(所有者)下拉菜单选择您希望拥有该仓库的账户。

    Screenshot of the owner menu for a new GitHub repository. The menu shows two options, octocat and github.

  3. 为您的仓库输入名称及可选的描述。如果您正在创建用户或组织站点,仓库必须命名为 <user>.github.io<organization>.github.io。如果您的用户或组织名称中包含大写字母,必须将其转换为小写。更多信息,请参阅 GitHub Pages 是什么?

    Screenshot of GitHub Pages settings in a repository. The repository name field contains the text "octocat.github.io" and is outlined in dark orange.

  4. 选择仓库可见性。欲了解更多信息,请参阅 关于仓库

  5. Add README 切换为 On

  6. 点击 创建仓库

创建站点

在创建站点之前,您必须在 GitHub 上拥有该站点的仓库。如果您不是在已有仓库中创建站点,请参阅 为站点创建仓库

警告

GitHub Pages 站点在互联网上公开可访问,即使站点的仓库是私有的(前提是您的计划或组织允许)。如果您的站点仓库中包含敏感数据,您可能希望在发布前将其移除。更多信息,请参阅 关于仓库

  1. 在 GitHub 上,前往您站点的仓库。

  2. 决定您想使用的发布源。参见 配置 GitHub Pages 站点的发布源

  3. 为您的站点创建入口文件。GitHub Pages 将查找 index.htmlindex.mdREADME.md 文件作为站点的入口文件。

    如果您的发布源是分支和文件夹,则入口文件必须位于源分支上源文件夹的顶层。例如,如果您的发布源是 main 分支上的 /docs 文件夹,则入口文件必须位于名为 main 的分支上的 /docs 文件夹中。

    如果您的发布源是 GitHub Actions 工作流,则您部署的工件必须在工件的顶层包含入口文件。您可以选择在工作流运行时让 GitHub Actions 工作流生成入口文件,而不是将入口文件添加到仓库中。

  4. 配置您的发布源。参见 配置 GitHub Pages 站点的发布源

  5. 您的 GitHub Pages 站点使用 GitHub Actions 工作流进行构建和部署。更多信息,请参阅 查看工作流运行历史

    注意

    GitHub Actions 对公开仓库免费。对于超过每月免费分钟配额的私有和内部仓库,将按使用量收费。更多信息,请参阅 计费与使用

查看已发布的站点

  1. 在仓库名称下,点击 设置。如果看不到 “Settings” 选项卡,请选择 下拉菜单,然后点击 设置

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  2. 在侧边栏的“代码和自动化”部分,点击 Pages

  3. 要查看已发布的站点,请在 “GitHub Pages” 下,点击 访问站点

注意

在您将更改推送至 GitHub 后,站点的更改可能需要长达 10 分钟才能发布。如果在一小时后仍未在浏览器中看到 GitHub Pages 站点的更改,请参阅 关于 GitHub Pages 站点的 Jekyll 构建错误

  • 如果您从分支发布且站点未自动发布,请确保具有管理员权限且已验证电子邮件地址的用户已向发布源推送。
  • 使用 GITHUB_TOKEN 的 GitHub Actions 工作流推送的提交不会触发 GitHub Pages 构建。

静态站点生成器

GitHub Pages 会发布您推送到仓库的所有静态文件。您可以自行创建静态文件,或使用静态站点生成器来构建站点。您也可以在本地或其他服务器上自定义构建流程。

如果您使用自定义构建流程或除 Jekyll 之外的静态站点生成器,可以编写 GitHub Actions 工作流来构建并发布站点。GitHub 为多种静态站点生成器提供了工作流模板。更多信息请参见 配置 GitHub Pages 站点的发布源

如果您从源分支发布站点,GitHub Pages 默认会使用 Jekyll 构建站点。若想使用除 Jekyll 之外的其他静态站点生成器,建议编写 GitHub Actions 来构建并发布站点。否则,可通过在发布源根目录创建一个空文件 .nojekyll 来禁用 Jekyll 构建过程,然后按照您所使用的静态站点生成器的说明在本地构建站点。

注意

GitHub Pages 不支持 PHP、Ruby 或 Python 等服务器端语言。

MIME 类型在 GitHub Pages 上

MIME 类型是服务器发送给浏览器的头信息,用以告知浏览器所请求文件的性质和格式。GitHub Pages 支持 750 多种 MIME 类型,覆盖数千种文件扩展名。受支持的 MIME 类型列表来源于 mime-db 项目

虽然无法为单个文件或仓库自定义 MIME 类型,但您可以在 GitHub Pages 上添加或修改 MIME 类型。更多信息请参见 mime-db 贡献指南

后续步骤

您可以通过创建更多新文件来为站点添加页面。每个文件将在站点中以与发布源相同的目录结构提供。例如,如果项目站点的发布源是 gh-pages 分支,并且您在该分支上创建了一个名为 /about/contact-us.md 的新文件,则该文件将在 https://<user>.github.io/<repository>/about/contact-us.html 可访问。

您还可以添加主题来自定义站点的外观和感觉。更多信息请参见 使用 Jekyll 为 GitHub Pages 站点添加主题

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.