blogs/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2026-08-24 15:28:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify GitHub Pages Branches

Browse Source
This commit is contained in:
rick-masters
2022-02-02 12:09:39 -08:00
committed by Bjørn Erik Pedersen
parent 94660c34b6
commit 037d633649
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/hosting-and-deployment/hosting-on-github.md
+6 -4
View File
@@ -34,14 +34,16 @@ There are two types of GitHub Pages:
Please refer to the [GitHub Pages documentation][ghorgs] to decide which type of site you would like to create as it will determine which of the below methods to use. Please refer to the [GitHub Pages documentation][ghorgs] to decide which type of site you would like to create as it will determine which of the below methods to use.
## Branches for GitHub Actions
The GitHub Actions used in these instructions pull source content from the `main` branch and then commit the generated content to the `gh-pages` branch. This applies regardless of what type of GitHub Pages you are using. This is a clean setup as your Hugo files are stored in one branch and your generated files are published into a separate branch.
## GitHub User or Organization Pages ## GitHub User or Organization Pages
As mentioned in the [GitHub Pages documentation][ghorgs], you can host a user/organization page in addition to project pages. Here are the key differences in GitHub Pages websites for Users and Organizations: As mentioned in the [GitHub Pages documentation][ghorgs], you can host a user/organization page in addition to project pages. Here are the key differences in GitHub Pages websites for Users and Organizations:
1. You must use a `<USERNAME>.github.io` to host your **generated** content 1. You must create a repository named `<USERNAME>.github.io` or `<ORGANIZATION>.github.io` to host your pages
2. Content from the `main` branch will be used to publish your GitHub Pages site 2. By default, content from the `main` branch is used to publish GitHub Pages - rather than the `gh-pages` branch which is the default for project sites. However, the GitHub Actions in these instructions publish to the `gh-pages` branch. Therefore, if you are publishing Github pages for a user or organization, you will need to change the publishing branch to `gh-pages`. See the instructions later in this document.
This is a much simpler setup as your Hugo files and generated content are published into two different repositories.
## Build Hugo With GitHub Action ## Build Hugo With GitHub Action