跳至主要内容

创建 GitHub Pages 网站

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

谁可以使用此功能?

GitHub Pages 在使用 GitHub Free 和 GitHub Free for organizations 的公共仓库中可用,在使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库中可用。有关更多信息,请参阅“GitHub 的计划”。

从 2024 年 6 月 30 日起,所有 GitHub Pages 构建都将使用 GitHub Actions。无需进行其他更改,但必须在您的仓库中启用 GitHub Actions 才能继续构建。有关启用 GitHub Actions 的更多信息,请参阅“管理仓库的 GitHub Actions 设置”。

注意:组织所有者可以限制从组织拥有的仓库发布 GitHub Pages 网站。有关更多信息,请参阅“管理组织的 GitHub Pages 网站发布”。

为您的网站创建仓库

您可以创建仓库或选择现有仓库作为您的网站。

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

如果拥有仓库的帐户使用 GitHub Free 或 GitHub Free for organizations,则仓库必须是公开的。

如果你想在一个已有的仓库中创建网站,请跳到 "创建你的网站" 部分。

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

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

  2. 使用 **所有者** 下拉菜单选择你想要拥有该仓库的帐户。

    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. 选择 **使用 README 初始化此仓库**。

  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. 在您的存储库名称下,单击 设置。如果您看不到“设置”选项卡,请选择下拉菜单,然后单击设置

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

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

  7. 要查看已发布的网站,在“GitHub Pages”下,单击 访问网站

    Screenshot of a confirmation message for GitHub Pages listing the site's URL. To the right of the URL, a button labeled "Visit site" is outlined in dark orange.

    注意:将更改推送到 GitHub 后,您的网站更改可能需要长达 10 分钟才能发布。如果您在一个小时后在浏览器中没有看到 GitHub Pages 网站更改的反映,请参阅“关于 GitHub Pages 网站的 Jekyll 构建错误”。

  8. 您的 GitHub Pages 网站使用 GitHub Actions 工作流构建和部署。有关更多信息,请参阅“查看工作流运行历史记录”。

    注意:GitHub Actions 对公共存储库免费。对超出每月免费分钟配额的私有和内部存储库收取使用费。有关更多信息,请参阅“使用限制、计费和管理”。

备注:

  • 如果您从分支发布,并且您的网站没有自动发布,请确保具有管理员权限且经过验证的电子邮件地址的用户已将代码推送到发布源。

  • 使用 `GITHUB_TOKEN` 的 GitHub Actions 工作流推送的提交不会触发 GitHub Pages 构建。

下一步

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

您还可以添加主题以自定义网站的外观和感觉。有关更多信息,请参阅“使用 Jekyll 为您的 GitHub Pages 网站添加主题”。

要进一步自定义您的网站,您可以使用 Jekyll,这是一个具有 GitHub Pages 内置支持的静态网站生成器。有关更多信息,请参阅“关于 GitHub Pages 和 Jekyll”。

进一步阅读