Getting started with GitHub Pages

You can set up a basic GitHub Pages site for yourself, your organization, or your project.

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.

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.

Creating a GitHub Pages site

You can create a GitHub Pages site in a new or existing repository.

GitHub Pages limits

Learn about the limits and limitations of GitHub Pages.

Using custom workflows with GitHub Pages

You can take advantage of using GitHub Actions and GitHub Pages by creating a workflow file or choosing from the predefined workflows.

Configuring a publishing source for your GitHub Pages site

You can configure your GitHub Pages site to publish when changes are pushed to a specific branch, or you can write a GitHub Actions workflow to publish your site.

Deleting a GitHub Pages site

You can delete a GitHub Pages site.

Unpublishing a GitHub Pages site

You can unpublish your GitHub Pages site so that your current deployment is removed and the site is no longer available. This is different from deleting the site.

Changing the visibility of your GitHub Pages site

You can manage access control for your project site by publishing the site publicly or privately.

Creating a custom 404 page for your GitHub Pages site

You can display a custom 404 error page when people try to access nonexistent pages on your site.

Securing your GitHub Pages site with HTTPS

HTTPS adds a layer of encryption that prevents others from snooping on or tampering with traffic to your site. You can enforce HTTPS for your GitHub Pages site to transparently redirect all HTTP requests to HTTPS.

Using submodules with GitHub Pages

You can use submodules with GitHub Pages to include other projects in your site's code.

Troubleshooting 404 errors for GitHub Pages sites

This guide will help you troubleshoot common reasons you may be seeing a 404 error.