mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-19 08:44:57 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
190 lines
6 KiB
Markdown
190 lines
6 KiB
Markdown
---
|
|
title: Host on GitHub Pages
|
|
description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with GitHub Actions
|
|
categories: [hosting and deployment]
|
|
keywords: [hosting,github]
|
|
menu:
|
|
docs:
|
|
parent: hosting-and-deployment
|
|
toc: true
|
|
aliases: [/tutorials/github-pages-blog/]
|
|
---
|
|
|
|
GitHub provides free and fast static hosting over SSL for personal, organization, or project pages directly from a GitHub repository via its GitHub Pages service and automating development workflows and build with GitHub Actions.
|
|
|
|
## Prerequisites
|
|
|
|
1. [Create a GitHub account]
|
|
2. [Install Git]
|
|
3. [Create a Hugo site] and test it locally with `hugo server`.
|
|
|
|
[Create a GitHub account]: https://github.com/signup
|
|
[Install Git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
|
|
[Create a Hugo site]: /getting-started/quick-start/
|
|
|
|
## Types of sites
|
|
|
|
There are three types of GitHub Pages sites: project, user, and organization. Project sites are connected to a specific project hosted on GitHub. User and organization sites are connected to a specific account on GitHub.com.
|
|
|
|
{{% note %}}
|
|
See the [GitHub Pages documentation] to understand the requirements for repository ownership and naming.
|
|
|
|
[GitHub Pages documentation]: https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites
|
|
{{% /note %}}
|
|
|
|
[GitHub Pages documentation]: https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites
|
|
|
|
## Procedure
|
|
|
|
Step 1
|
|
: Create a GitHub repository.
|
|
|
|
Step 2
|
|
: Push your local repository to GitHub.
|
|
|
|
Step 3
|
|
: Visit your GitHub repository. From the main menu choose **Settings** > **Pages**. In the center of your screen you will see this:
|
|
|
|
|
|
{style="max-width: 280px"}
|
|
|
|
Step 4
|
|
: Change the **Source** to `GitHub Actions`. The change is immediate; you do not have to press a Save button.
|
|
|
|
|
|
{style="max-width: 280px"}
|
|
|
|
Step 5
|
|
: Create an empty file in your local repository.
|
|
|
|
```text
|
|
.github/workflows/hugo.yaml
|
|
```
|
|
|
|
Step 6
|
|
: Copy and paste the YAML below into the file you created. Change the branch name and Hugo version as needed.
|
|
|
|
{{< code file=.github/workflows/hugo.yaml copy=true >}}
|
|
# Sample workflow for building and deploying a Hugo site to GitHub Pages
|
|
name: Deploy Hugo site to Pages
|
|
|
|
on:
|
|
# Runs on pushes targeting the default branch
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
|
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
# Default to bash
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
|
|
jobs:
|
|
# Build job
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
HUGO_VERSION: 0.122.0
|
|
steps:
|
|
- name: Install Hugo CLI
|
|
run: |
|
|
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
|
|
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
|
|
- name: Install Dart Sass
|
|
run: sudo snap install dart-sass
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
submodules: recursive
|
|
fetch-depth: 0
|
|
- name: Setup Pages
|
|
id: pages
|
|
uses: actions/configure-pages@v4
|
|
- name: Install Node.js dependencies
|
|
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
|
|
- name: Build with Hugo
|
|
env:
|
|
# For maximum backward compatibility with Hugo modules
|
|
HUGO_ENVIRONMENT: production
|
|
HUGO_ENV: production
|
|
run: |
|
|
hugo \
|
|
--gc \
|
|
--minify \
|
|
--baseURL "${{ steps.pages.outputs.base_url }}/"
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v2
|
|
with:
|
|
path: ./public
|
|
|
|
# Deployment job
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v3
|
|
{{< /code >}}
|
|
|
|
Step 7
|
|
: Commit the change to your local repository with a commit message of something like "Add workflow", and push to GitHub.
|
|
|
|
Step 8
|
|
: From GitHub's main menu, choose **Actions**. You will see something like this:
|
|
|
|
|
|
{style="max-width: 350px"}
|
|
|
|
Step 9
|
|
: When GitHub has finished building and deploying your site, the color of the status indicator will change to green.
|
|
|
|
|
|
{style="max-width: 350px"}
|
|
|
|
Step 10
|
|
: Click on the commit message as shown above. You will see this:
|
|
|
|
|
|
{style="max-width: 611px"}
|
|
|
|
Under the deploy step, you will see a link to your live site.
|
|
|
|
In the future, whenever you push a change from your local repository, GitHub will rebuild your site and deploy the changes.
|
|
|
|
## Customize the workflow
|
|
|
|
The example workflow above includes this step, which typically takes 10‑15 seconds:
|
|
|
|
```yaml
|
|
- name: Install Dart Sass
|
|
run: sudo snap install dart-sass
|
|
```
|
|
|
|
You may remove this step if your site, themes, and modules do not transpile Sass to CSS using the [Dart Sass] transpiler.
|
|
|
|
[Dart Sass]: /hugo-pipes/transpile-sass-to-css/#dart-sass
|
|
|
|
## Additional resources
|
|
|
|
- [Learn more about GitHub Actions](https://docs.github.com/en/actions)
|
|
- [Caching dependencies to speed up workflows](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows)
|
|
- [Manage a custom domain for your GitHub Pages site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
|