Skip to main content

此版本的 GitHub Enterprise 将停止服务 2022-10-12. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

关于 GitHub Pages

您可以使用 GitHub Pages 直接从 your GitHub Enterprise Server instance 上的仓库托管关于自己、您的组织或您的项目的站点。

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

关于 GitHub Pages

GitHub Pages 是一项静态站点托管服务,它直接从 GitHub Enterprise Server 上的仓库获取 HTML、CSS 和 JavaScript 文件,(可选)通过构建过程运行文件,然后发布网站。 可以在 GitHub Pages 示例集合中看到 GitHub Pages 站点的示例。

若要开始,请参阅“创建 GitHub Pages 站点”。

组织所有者可禁止从组织的存储库发布 GitHub Pages 站点。 有关详细信息,请参阅“为组织管理 GitHub Pages 站点的发布”。

GitHub Pages 站点的类型

有三种类型的 GitHub Pages 站点:项目、用户和组织。 项目站点连接到 GitHub Enterprise Server 上托管的特定项目,例如 JavaScript 库或配方集合。 用户和组织站点连接到 your GitHub Enterprise Server instance 上的特定帐户。

若要发布用户站点,必须创建名为 <username>.<hostname> 的个人帐户拥有的存储库。 若要发布组织站点,必须创建名为 <organization>.<hostname> 的组织帐户拥有的存储库。

项目站点的源文件与其项目存储在同一个仓库中。

您只能为 GitHub Enterprise Server 上的每个帐户创建一个用户或组织站点。 项目站点(无论是组织还是个人帐户拥有)没有限制。

你的站点可用的 URL 取决于是否为 your GitHub Enterprise Server instance 启用了子域隔离。

站点类型子域隔离已启用子域隔离已禁用
用户http(s)://pages.<hostname>/<username>http(s)://<hostname>/pages/<username>
组织http(s)://pages.<hostname>/<organization>http(s)://<hostname>/pages/<organization>
个人帐户拥有的项目站点http(s)://pages.<hostname>/<username>/<repository>/http(s)://<hostname>/pages/<username>/<repository>/
组织帐户拥有的项目站点http(s)://pages.<hostname>/<orgname>/<repository>/http(s)://<hostname>/pages/<orgname>/<repository>/

有关详细信息,请参阅“启用子域隔离”或者与站点管理员联系。

GitHub Pages 站点的发布来源

警告:如果你的站点管理员启用了公共页面,GitHub Pages 站点将在 Internet 上公开,即使该站点的存储库是私有的或内部的也是如此。 如果站点的存储库中有敏感数据,你可能想要在发布前删除数据。 有关详细信息,请参阅“为企业配置 GitHub Pages”和“关于存储库”。

将更改推送到特定分支时,会发布 GitHub Pages 站点。 可以指定要用作发布源的分支和文件夹。 源分支可以是存储库中的任何分支,源文件夹可以是源分支上的存储库根目录 (/),也可以是源分支上的 /docs 文件夹。 将更改推送到源分支时,源文件夹中的更改将发布到 GitHub Pages 站点。

有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。

静态站点生成器

GitHub Pages 会发布您推送到仓库的任何静态文件。 您可以创建自己的静态文件或使用静态站点生成器为您构建站点。 您还可以在本地或其他服务器上自定义自己的构建过程。

我们建议使用 Jekyll,它是一个静态站点生成器,内置 GitHub Pages 支持和简化的构建流程。 有关详细信息,请参阅“关于 GitHub Pages 和 Jekyll”。

默认情况下,GitHub Pages 将使用 Jekyll 来构建您的站点。 如果你想使用除 Jekyll 以外的静态站点生成器,通过在发布来源的根目录中创建一个名为 .nojekyll 的空文件来禁用 Jekyll 构建过程,然后按照静态站点生成器的说明在本地构建站点。

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

GitHub Pages 使用限制

GitHub Pages 并非旨在用于或允许用作免费的 Web 托管服务来运行你的在线业务、电子商务站点或主要针对促进商业交易或提供商业软件即服务 (SaaS) 的任何其他网站。 GitHub Pages 站点不应该用于敏感事务,例如发送密码或信用卡号码。

此外,你对 GitHub Pages 的使用受 GitHub 服务条款的约束,包括对快速致富计划、淫秽内容以及暴力或威胁性内容或活动的限制。

使用限制

GitHub Pages 站点受到以下使用限制的约束:

  • GitHub Pages 源存储库的建议限制为 1 GB。
  • 发布的 GitHub Pages 站点不得超过 1 GB。

GitHub Pages 上的 MIME 类型

MIME 类型是服务器发送到浏览器的标头,提供有关浏览器所请求文件性质和格式的信息。 GitHub Pages 支持数千种文件扩展名中 750 多种 MIME 类型。 支持的 MIME 类型列表是从 mime-db 项目生成的。

虽然无法基于每个文件或每个仓库指定自定义 MIME 类型,但您可以添加或修改 MIME 类型以在 GitHub Pages 上使用。 有关详细信息,请参阅 mime-db 贡献指南

延伸阅读