What is GitHub Pages?
You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a repository on GitHub.
Who can use this feature?
GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, seeGitHub’s plans.
In this article
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 theGitHub 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> |
Hosting on your own custom domain
You can host your site on GitHub'sgithub.io domain or your own custom domain. SeeConfiguring a custom domain for your GitHub Pages site.
Data collection
When a GitHub Pages site is visited, the visitor's IP address is logged and stored for security purposes, regardless of whether the visitor has signed into GitHub or not. For more information about GitHub's security practices, seeGitHub Privacy Statement.