Article version: GitHub.com

Configuring a publishing source for your GitHub Pages site

If you use the default publishing source for your GitHub Pages site, your site will publish automatically. You can also choose to publish your project site from a different branch or folder.

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

People with admin permissions for a repository can configure a publishing source for a GitHub Pages site.

For more information about publishing sources, see "About GitHub Pages."

In this article

Choosing a publishing source

Before you configure a publishing source, make sure the branch or folder you want to use as your publishing source already exists in your repository. For example, before you can publish your project site from the /docs folder on the master branch of your repository, you or a collaborator must create a /docs folder on the master branch of your repository.

  1. On GitHub, navigate to your site's repository.

  2. Under your repository name, click Settings.

    Repository settings button

  3. Under "GitHub Pages", use the Source drop-down menu and select a publishing source.

    Drop down menu to select a publishing source

Troubleshooting publishing problems with your GitHub Pages site

Note: If your site's source files are located in the default publishing source—master for user and organization sites or gh-pages for project sites—but your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the default publishing source.

If you remove the /docs folder from the master branch after choosing the docs folder as your publishing source, your site won't build and you'll get a page build error message for a missing /docs folder. For more information, see "Troubleshooting Jekyll build errors for GitHub Pages sites."

Ask a human

Can't find what you're looking for?

Contact us