#Github pages branch how to#
#Github pages branch code#

#Github pages branch code#

Have a separate repository for your source code (so is used only for deployment and not really for tracking your source code).This means you do not necessarily have to change your default branch.

#Github pages branch how to#

Note: GitHub Pages lets you use any branch for deployment, see this docs page on how to do this.

Change the default branch in your repository settings (“Branches” menu item) from main to source.

To create a new branch called source run this command:.

Change the default branch from main to something else, and use main as a site deployment directory only:.

So if you use main for development you need to do one of these:

⚠️ Keep in mind that GitHub Pages forces deployment of user/organization pages to the main branch. Deploying to a GitHub Pages subdomain at github.ioįor a repository named like, you don’t need to specify pathPrefix and your website needs to be pushed to the main branch. To address this, use the -f option from the gh-pages command to avoid keeping an history of the GitHub Pages branch. This might slow down operations like clone and increase disk usage. ⚠️ As your repository will grow and get more commits, so will your gh-pages branch. If you don’t have a main or gh-pages branch, you can create them and then return to source settings to change your publishing source. Note: To select main or gh-pages as your publishing source, you must have the branch present in your repository. Make sure that your repository’s settings has the gh-pages branch set as the source to deploy from. When you run npm run deploy all contents of the public folder will be moved to your repository’s gh-pages branch. Then add a deploy script to package.json in your repository’s codebase: You’ll need to add your /reponame path prefix as an option to gatsby-config.js:

Specific instructions Deploying to a path with pathPrefixįor sites deployed at a path like /reponame/, the -prefix-paths flag is used because your website will end up inside a folder like /reponame/. See the instructions below how to configure it (as it depends on what option you’ll choose). This will make it easier to publish your Gatsby site to GitHub pages. You can add a custom deploy script to the 'scripts' section of your package.json. The best way to push a Gatsby app to GitHub Pages is by using a package called gh-pages. In the GitHub Pages section, use the “Source” drop-down to select main (for publishing to the root subdomain) or gh-pages (for publishing to a path like /docs) as your GitHub Pages publishing source.Under the repository name, click “Settings”.You must select which branch will be deployed from your repository settings in GitHub for GitHub Pages to function. General instructions Configuring the GitHub Pages source branch (Need help creating one? Follow the Quick Start) to the root subdomain at, and then configured to use a custom domain.to a subdomain based on your username or organization name: or.You can publish your site on GitHub Pages several different ways: A Gatsby site can be hosted on GitHub Pages with a few configurations to the codebase and the repository’s settings. GitHub Pages is a service offered by GitHub that allows hosting for websites configured straight from the repository.