About GitHub Pages
GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, 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.
Types of GitHub Pages sites
There are two types of GitHub Pages sites. Sites associated with a user or organization account, and sites for a specific project.
Property | User and organization sites | Project sites |
---|---|---|
Source files | Must be stored in a repository named <owner>.github.io , where <owner> is the personal or organization account name |
Stored in a folder within the repository that contains the project's code |
Limits | Maximum of one pages site per account | Maximum of one pages site per repository |
Default site location | http(s)://<owner>.github.io |
http(s)://<owner>.github.io/<repositoryname> |
If you publish your site privately, the URL for your site will be different. For more information, see 更改 GitHub Pages 站点的可见性.
Hosting on your own custom domain
You can host your site on GitHub's github.io
domain or your own custom domain. See 配置 GitHub Pages 站点的自定义域.
Further reading
- GitHub Pages on GitHub Skills
- 存储库的 REST API 终结点
- 配置 GitHub Pages 站点的发布源
- 关于自定义域名和 GitHub 页面