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, see GitHub’s plans.

GitHub Pages now uses GitHub Actions to execute the Jekyll build. When using a branch as the source of your build, GitHub Actions must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if GitHub Actions is unavailable or disabled, adding a .nojekyll file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling GitHub Actions, see Managing GitHub Actions settings for a repository.

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 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 Changing the visibility of your GitHub Pages site.

Hosting on your own custom domain

You can host your site on GitHub's github.io domain or your own custom domain. See Configuring a custom domain for your GitHub Pages site.

Further reading