Zenn
🫰

Hugo × GitHub Pages: 無料・手軽にウェブサイトをSSGで公開する方法

2023/11/18に公開
Hugo
tech

はじめに

Hugoは優れた静的サイトジェネレーターであり、そのシンプルかつ効率的な構造により、ウェブサイトの素早い構築が可能です。一方で、GitHub Pagesは静的なウェブサイトを無料でホスティングできる優れたプラットフォームとして知られています。この組み合わせは、コンテンツ制作とホスティングのプロセスをスムーズに統合できるので、今回はHugoとGithubPageを使ってデプロイまでの流れを書いていきたいと思います。

ソースコードを見たい方はこちら

Hugoの優れた特徴

Hugoはシンプルなコマンドラインツールを駆使して、美しく高速な静的ウェブサイトを生成します。以下に、Hugoの魅力的な特徴をいくつか挙げてみましょう。

高速なビルドプロセス

  • HugoはGo言語で開発されており、非常に高速で効率的なビルドプロセスを提供します。これにより、大規模なウェブサイトでも素早くプレビューを確認できます。

豊富なテーマサポート

  • Hugoは豊富なテーマのサポートを提供しており、ユーザーは容易にウェブサイトの外観をカスタマイズできます。様々なテーマから選択し、プロジェクトに最適なものを利用できます。

マークダウンのサポート

  • Hugoはマークダウン形式を採用しており、記事の作成や編集が直感的で簡単です。マークダウンの柔軟性を利用して、豊かなコンテンツを作成できます。

GitHub Pagesの利点

GitHub PagesはHugoと組み合わせることで、ウェブサイトを公開しやすくするための理想的な選択肢です。以下に、GitHub Pagesの主な利点を紹介します。

無料ホスティング

  • GitHub Pagesは無料で提供されており、プロジェクトや個人のために手軽なウェブホスティングを提供しています。

簡単なセットアップ

  • GitHub PagesはGitHubリポジトリを使用してホスティングされるため、プロジェクトのソースコードとウェブサイトが一元管理され、簡単に設定できます。

自動ビルド(Github Actionを使用した場合)

  • GitHub PagesはGithub Actionを設定することでコミットが行われるたびに自動的にビルドを行います。この仕組みにより、開発者は手動でウェブサイトをビルドする手間を省くことができます。

HugoとGitHub Pagesを組み合わせることで、開発者は効率的で美しいウェブサイトを構築し、無料かつ容易に公開できるため、プロジェクトの展開やコンテンツの発信がスムーズに行えます。

作成手順

1. Hugoのインストール

最初に、Hugoをインストールします。今回はmacOSでHomebrewを使ったインストール方法を示します。
ターミナルやコマンドプロンプトで以下のコマンドを実行します。

brew install hugo

Hugoをダウンロードする他の方法については、Hugoの公式サイトを参照してください。

2. 新しいHugoサイトの作成

次に、Hugoコマンドを使用して新しいサイトを作成します。今回はmy-hugo-siteというプロジェクト名で作成します。

hugo new site my-hugo-site

3. テーマの選択

Hugoにはさまざまなテーマがあります。テーマを選んでインストールしましょう。例えば、Anankeを使用する場合は、以下のようにします。

cd my-hugo-site
git init
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
echo "theme = 'ananke'" >> hugo.toml
hugo server

参照：https://gohugo.io/getting-started/quick-start/#commands

4. ローカルでサイトをビルドして確認

以下のコマンドでローカルサーバーを起動し、ウェブサイトが正しく表示されるか確認します。

hugo server -D

5. GitHubリポジトリの作成とPagesの有効化

GitHub上で新しいリポジトリを作成します。

GitHubのリポジトリ設定ページに進み、"Settings" タブ内の "Pages" セクションで、Build and deploymentセクションを確認してください。そこでソースを main branch に設定します。
この手順によって、GitHub Pagesを利用して静的なウェブサイトをホスティングする準備が整います。

6. GitHub Actionの設定

.github/workflows/hugo.yamlに以下のファイルを定義してください。


# 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.120.2
    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@v3
      - 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@v2

参照：https://gohugo.io/hosting-and-deployment/hosting-on-github/

7. GitHubにプッシュ

作成したリポジトリのmain branch　にpush すれば完了です。

最後に

これで、Hugoで作成したウェブサイトがGitHub Pagesでホスティングされているはずです。記事を追加したり、カスタマイズしたりするには、Hugoコマンドを使用してローカルで作業し、変更をGitHubにプッシュしてください。GitHub Pagesは自動的にビルドされ、更新されたウェブサイトが提供されます。

Discussion