Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

创建 GitHub Pages 站点

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

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

注意: 组织所有者可以限制从组织拥有的存储库发布 GitHub Pages 站点。 有关详细信息,请参阅“管理 GitHub Pages 站点的发布”。

为站点创建仓库

可以为站点创建存储库或选择现有存储库。

如果存储库中并非所有文件都与站点相关,且要为存储库创建 GitHub Pages 站点,则能够为站点配置发布源。 例如,可以使用专用分支和文件夹保存站点源文件,也可以使用自定义 GitHub Actions 工作流来生成和部署站点源文件。

如果拥有存储库的帐户使用组织的 GitHub Free 或 GitHub Free,存储库必须是公共的。

如果要在现有存储库中创建站点,请跳至“创建站点”一节。

  1. 在任何页面的右上角,使用 下拉菜单选择“新建存储库”。 包含创建新存储库选项的下拉菜单 1. 使用“所有者”下拉菜单选择你想要拥有存储库的帐户。 “所有者”下拉菜单
    注意:如果你是 managed user account,将只能从组织拥有的存储库发布 GitHub Pages 站点。 有关详细信息,请参阅“关于 GitHub Pages”。
    1. 输入仓库的名称和说明(可选)。 如果要创建用户或组织站点,则存储库必须命名为 `.github.io` 或 `.github.io`。 如果您的用户或组织名称包含大写字母,您必须小写字母。 有关详细信息,请参阅“[关于 GitHub Pages](/articles/about-github-pages#types-of-github-pages-sites)”。 ![创建存储库字段](/assets/images/help/pages/create-repository-name-pages.png) 1. 选择仓库可见性。 有关详细信息,请参阅“[关于存储库](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)”。 ![用于选择存储库可见性的单选按钮](/assets/images/help/repository/create-repository-public-private.png) 1. 选择“使用 README 初始化此存储库”。 ![“使用自述文件初始化此存储库”复选框](/assets/images/help/repository/initialize-with-readme.png) 1. 单击“创建存储库”。 ![创建存储库的按钮](/assets/images/help/repository/create-repository-button.png)

创建站点

必须先在 GitHub Enterprise Cloud 上有站点的仓库,然后才可创建站点。 如果未在现有存储库中创建站点,请参阅“为站点创建存储库”。

警告:除非你的企业使用 Enterprise Managed Users,否则默认情况下 GitHub Pages 站点可以在 Internet 上公开,即使该站点的存储库是私有的或内部的。 可以通过管理站点的访问控制来私下发布站点。 否则,如果站点的存储库中有敏感数据,你可能想要在发布前删除数据。 有关详细信息,请参阅“关于存储库”和“更改 GitHub Pages 站点的可见性”。

  1. 在 GitHub Enterprise Cloud 上,导航到站点的仓库。 1. 确定要使用的发布源。 有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。

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

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

    如果发布源是 GitHub Actions 工作流,则部署的项目必须在项目的顶层包含入口文件。 可以选择使用 GitHub Actions 工作流在工作流运行时生成入口文件,而不是将入口文件添加到存储库。 1. 配置发布源。 有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮

  3. 在边栏的“代码和自动化”部分,单击“ 页面”。

  4. (可选)如果要从专用或内部存储库发布项目网站,请选择站点可见性。 在“GitHub Pages”下,选择“GitHub Pages 可见性”下拉菜单,然后单击可见性。 有关详细信息,请参阅“更改 GitHub Pages 站点的可见性”。 用于选择站点可见性的下拉菜单

      <div class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5">
    

    注意:若要私下发布 GitHub Pages 网站,组织必须使用 GitHub Enterprise Cloud。 有关如何免费试用 GitHub Enterprise Cloud 的详细信息,请参阅“设置 GitHub Enterprise Cloud 的试用版”。

    1. 若要查看已发布的网站,请在“GitHub Pages”下单击“ 访问网站”。 ![一个发布的网站 URL 旁边的“访问网站”按钮的屏幕截图](/assets/images/help/pages/click-pages-url-to-preview.png)

    注意: 对站点的更改在推送到 GitHub Enterprise Cloud 后,最长可能需要 10 分钟才会发布。 如果一小时后仍然在浏览器中看不到 GitHub Pages 站点更改,请参阅“关于 GitHub Pages 站点的 Jekyll 生成错误”。

  5. GitHub Pages 站点是使用 GitHub Actions 工作流生成和部署的。 有关详细信息,请参阅“查看工作流运行历史记录”。

    注意:公共存储库免费使用 GitHub Actions。 如果专用存储库和内部存储库超出每月分配的免费分钟数,则会收取使用费。 有关详细信息,请参阅“使用限制、计费和管理”。

注意:如果从分支进行发布且站点尚未自动发布,请确保具有管理员权限和经验证的电子邮件地址的人员已将站点推送到发布源。

后续步骤

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

您还可以添加主题以自定义网站的外观。 有关详细信息,请参阅“使用 Jekyll 将主题添加到 GitHub Pages 站点”。

要更多地自定义您的站点,您可以使用 Jekyl - 内置 GitHub Pages 支持的静态站点生成器。 有关详细信息,请参阅“关于 GitHub Pages 和 Jekyll”。

延伸阅读