我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

创建 GitHub Pages 站点

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

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

本文内容

Note: Organization owners can restrict the publication of GitHub Pages sites from repositories owned by the organization. For more information, see "Managing the publication of GitHub Pages sites."

为站点创建仓库

如果站点是一个独立的项目,您可以创建新仓库来存储站点源代码。 如果您的站点与现有的项目关联,您可以添加站点的源代码添加到该项目仓库的默认分支或其他分支上的 /docs 文件夹中。 例如,如果您创建站点来发布已经在 GitHub 中的项目文档, 您可能想要将站点的源代码存储在与项目相同的仓库中。

If the account that owns the repository uses GitHub Free or GitHub Free, the repository must be public.

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

  1. 在任何页面的右上角,使用 下拉菜单选择 New repository(新建仓库)
    带有创建新仓库选项的下拉菜单
  2. 使用 Owner(所有者)下拉菜单选择你想要拥有仓库的帐户。
    所有者下拉菜单
  3. 输入仓库的名称和说明(可选)。 如果您创建的是用户或组织站点,仓库名称必须为 <user>.github.io<organization>.github.io。 更多信息请参阅“关于 GitHub Pages”。
    创建仓库字段
  4. 选择仓库可见性。 更多信息请参阅“关于仓库可见性”。
    选择仓库可见性的单选按钮
  5. 选择 Initialize this repository with a README(使用自述文件初始化此仓库)
    使用自述文件初始化此仓库复选框
  6. 单击 Create repository(创建仓库)
    Button to create repository

创建站点

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

警告:GitHub Pages 站点 默认在互联网上公开,即使站点的仓库是私有或内部的。 If your project site is published from a private or internal repository owned by an organization using GitHub Enterprise Cloud, you can manage access control for the site. 否则,如果 您的站点仓库中有敏感数据,则您可能要在发布前删除该数据。 更多信息请参阅“关于仓库可见性”和“更改 GitHub Pages 站点的可见性”。

  1. 在 GitHub 上,导航到站点的仓库。

  2. 确定要使用的发布源。 更多信息请参阅“关于 GitHub Pages”。

  3. 如果所选发布源已存在,请导航到发布源。 如果所选发布源不存在,则创建发布源。

  4. 在发布源的根目录中,创建一个名为 index.md、包含要在网站主页上显示的内容的文件。

  5. 配置发布源。 更多信息请参阅“配置 GitHub Pages 站点的发布来源”。

  6. 在仓库名称下,单击 Settings(设置)

    仓库设置按钮

  7. Optionally, if you're publishing a project site from a private or internal repository owned by an organization using GitHub Enterprise Cloud, choose the visibility for your site. 在 "GitHub Pages" 下,选择 GitHub Pages visibility(可见性)下拉菜单,然后单击可见性。 For more information, see "Changing the visibility of your GitHub Pages site".

    Drop-down to select visibility for your site

  8. 要查看您已发布的站点,请在“GitHub Pages”下点击您的站点 URL。

    已发布站点的 URL

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

:如果网站 未自动发布,请确保有一个拥有管理权限和经验证的电子邮件地址的人已推送到默认发布源。

后续步骤

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

您还可以添加主题以自定义网站的外观。 更多信息请参阅“使用主题选择器添加主题到 GitHub Pages 站点”。

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

延伸阅读

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。