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

About GitHub Pages

You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a GitHub Enterprise Server repository.

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


About GitHub Pages

GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub Enterprise Server, optionally runs the files through a build process, and publishes a website. You can see examples of GitHub Pages sites in the GitHub Pages examples collection.

To get started, see "Creating a GitHub Pages site."

Types of GitHub Pages sites

There are three types of GitHub Pages sites: project, user, and organization. Project sites are connected to a specific project hosted on GitHub Enterprise Server, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific GitHub Enterprise Server account.

To publish a user site, you must create a repository owned by your user account that's named <username>.<hostname>. To publish an organization site, you must create a repository owned by an organization that's named <organization>.<hostname>.

The source files for a project site are stored in the same repository as their project.

You can only create one user or organization site for each account on GitHub Enterprise Server. Project sites, whether owned by an organization or a user account, are unlimited.

The URL where your site is available depends on whether subdomain isolation is enabled for 您的 GitHub Enterprise Server 实例.

Type of siteSubdomain isolation enabledSubdomain isolation disabled
Project site owned by user accounthttp(s)://pages.<hostname>/<username>/<repository>/http(s)://<hostname>/pages/<username>/<repository>/
Project site owned by organization accounthttp(s)://pages.<hostname>/<orgname>/<repository>/http(s)://<hostname>/pages/<orgname>/<repository>/

For more information, see "Enabling subdomain isolation" or contact your site administrator.

Publishing sources for GitHub Pages sites

The publishing source for your GitHub Pages site is the branch and folder where the source files for your site are stored.

警告:如果您的站点管理员启用了公共页面,GitHub Pages 站点将在互联网上公开,即使其仓库是私有的或内部的。 如果站点的仓库中有敏感数据,您可能想要在发布前删除它。 更多信息请参阅“为企业配置 GitHub Pages”和“关于仓库可见性”。

The default publishing source for user and organization sites is the master branch. If the repository for your user or organization site has a master branch, your site will publish automatically from that branch. You cannot choose a different publishing source for user or organization sites.

The default publishing source for a project site is the gh-pages branch. If the repository for your project site has a gh-pages branch, your site will publish automatically from that branch.

Project sites can also be published from the master branch or a /docs folder on the master branch. To publish your site from one of these sources, you must configure a different publishing source. For more information, see "Configuring a publishing source for your GitHub Pages site."

If you choose the /docs folder of the master branch as your publishing source, GitHub Pages will read everything to publish your site from the /docs folder.

You cannot publish your project site from any other branch, even if the default branch is not master or gh-pages.

Static site generators

GitHub Pages publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server. We recommend Jekyll, a static site generator with built-in support for GitHub Pages and a simplified build process. For more information, see "About GitHub Pages and Jekyll."

GitHub Pages will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, disable the Jekyll build process by creating an empty file called .nojekyll in the root of your publishing source, then follow your static site generator's instructions to build your site locally.

GitHub Pages does not support server-side languages such as PHP, Ruby, or Python.

Guidelines for using GitHub Pages

GitHub Pages sites are subject to the following usage limits:

  • GitHub Pages source repositories have a recommended limit of 1GB.
  • Published GitHub Pages sites may be no larger than 1 GB.

MIME types on GitHub Pages

A MIME type is a header that a server sends to a browser, providing information about the nature and format of the files the browser requested. GitHub Pages supports more than 750 MIME types across thousands of file extensions. The list of supported MIME types is generated from the mime-db project.

While you can't specify custom MIME types on a per-file or per-repository basis, you can add or modify MIME types for use on GitHub Pages. For more information, see the mime-db contributing guidelines.

Further reading


Privacy policy


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


或, 了解如何参与。