diff options
Diffstat (limited to 'docs/content/en/hosting-and-deployment/hosting-on-github.md')
| -rw-r--r-- | docs/content/en/hosting-and-deployment/hosting-on-github.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/content/en/hosting-and-deployment/hosting-on-github.md b/docs/content/en/hosting-and-deployment/hosting-on-github.md index 22acca568..35550ed99 100644 --- a/docs/content/en/hosting-and-deployment/hosting-on-github.md +++ b/docs/content/en/hosting-and-deployment/hosting-on-github.md @@ -43,11 +43,11 @@ The GitHub Actions used in these instructions pull source content from the `main 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 create a repository named `<USERNAME>.github.io` or `<ORGANIZATION>.github.io` to host your pages -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. +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. ## Build Hugo With GitHub Action -GitHub executes your software development workflows. Everytime you push your code on the GitHub repository, Github Actions will build the site automatically. +GitHub executes your software development workflows. Every time you push your code on the GitHub repository, GitHub Actions will build the site automatically. Create a file in `.github/workflows/gh-pages.yml` containing the following content (based on [actions-hugo](https://github.com/marketplace/actions/hugo-setup)): @@ -57,7 +57,7 @@ name: github pages on: push: branches: - - main # Set a branch to deploy + - main # Set a branch that will trigger a deployment pull_request: jobs: |