About GitHub Pages
You can use GitHub 页面 to host a website about yourself, your organization, or your project directly from a GitHub Enterprise repository.
GitHub 页面 可用于具有 GitHub Free 的公共仓库，以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。
本文内容
- 关于 GitHub 页面
- Types of GitHub 页面 sites
- Publishing sources for GitHub 页面 sites
- Static site generators
- Guidelines for using GitHub 页面
- MIME types on GitHub 页面
关于 GitHub 页面
GitHub 页面 is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub Enterprise, optionally runs the files through a build process, and publishes a website. You can see examples of GitHub 页面 sites in the GitHub 页面 examples collection.
To get started, see "Creating a GitHub 页面 site."
Types of GitHub 页面 sites
There are three types of GitHub 页面 sites: project, user, and organization. Project sites are connected to a specific project hosted on GitHub Enterprise, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific GitHub Enterprise account.
User and organization sites are always published from a repository named <user>.github.io or <organization>.github.io.
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 GitHub Enterprise account. 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 site | Subdomain isolation enabled | Subdomain isolation disabled |
|---|---|---|
| User |
http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ | Organization | http(s)://pages.<hostname>/<organization>/<repository>/ | http(s)://<hostname>/pages/<organization>/<repository>/ | Project site owned by user account | http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ Project site owned by organization account | http(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 页面 sites
The publishing source for your GitHub 页面 site is the branch or folder where the source files for your site are stored. All sites have a default publishing source, and project sites have additional publishing sources available.
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 页面 site."
If you choose the /docs folder of the master branch as your publishing source, GitHub 页面 will read everything to publish your site from the /docs folder.
Static site generators
GitHub 页面 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. 您还可以在本地或其他服务器上自定义自己的构建过程。 We recommend Jekyll, a static site generator with built-in support for GitHub 页面 and a simplified build process. For more information, see "About GitHub 页面 and Jekyll."
GitHub 页面 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 页面 does not support server-side languages such as PHP, Ruby, or Python.
Guidelines for using GitHub 页面
GitHub 页面 站点受到以下使用限制的约束：
- GitHub 页面 source repositories have a recommended limit of 1GB.
- 发布的 GitHub 页面 站点不得超过 1 GB。
MIME types on GitHub 页面
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 页面 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 页面. For more information, see the mime-db contributing guidelines.