Amazon10/19まで!プライム感謝祭開催中!セール会場へ

HugoとGitHub Pagesでポートフォリオを作る手順|旧Academicテーマとの違い

HugoはMarkdownから静的なWebページを生成するツールです。GitHub Pagesへ公開するには、Hugoのビルドと、GitHub側の公開設定を両方用意します。Gitへpushしただけで公開されるとは限りません。

この記事の元の作例はAcademicテーマを使った過去の構築記録です。現在の新規制作では、利用するテーマが指定するHugoの版・依存関係を確認し、現行の公式手順を使ってください。以下は公式資料に基づく準備と確認の案内で、今回の環境で公開まで実行した結果ではありません。

目次

Hugo・Gitと、テーマの条件を確認する

Hugo公式Quick startとWindowsへのインストールで必要な版を確認します。テーマによってExtended、Go、Node.jsなどが必要になるため、テーマのREADMEも確認してください。

PowerShellで次のコマンドが実行できるか確認します。

hugo version
git --version

手動でhugo.exeを配置した場合は、Windowsの環境変数の編集画面で、そのフォルダーをユーザーのPathへ追加し、新しいターミナルで確認します。古い記事のsetx /MでPath全体を書き換える方法は使いません。既存のPathを壊すと、別のツールも起動できなくなるためです。

ローカルでサイトを作り、先に表示を確認する

  1. 自分が管理する作業フォルダーで、公式Quick startのプロジェクト作成手順を進めます。
  2. 維持されているテーマを選び、そのテーマの導入手順に従います。旧Academicのフォルダー構成を別テーマへそのまま当てはめないでください。
  3. サイト名、プロフィール、作品と画像を設定します。一般に本文はcontent、変換せず配置するファイルはstaticへ置きますが、テーマによる構成の違いを確認します。
  4. プロジェクトのルートでhugo serverを実行し、ターミナルに表示されたローカルURLで確認します。
  5. hugoでビルドできるか確認します。通常の出力先はpublicですが、設定で変更できます。
hugo server
# 表示確認後、Ctrl+Cでサーバーを終了します。
hugo

baseURLは実際の公開先に合わせます。ユーザーサイトとプロジェクトサイトではパスが異なり、画像・CSSの参照先にも影響します。

GitHub Pagesへ公開する

Hugo公式のGitHub Pages手順は、GitHub Actionsでビルド・公開する方法です。ソースをリポジトリで管理し、生成されたpublicの内容をコミットする方法と混ぜないでください。

  1. 自分のGitHubアカウントでリポジトリを用意し、ローカルのソースと接続します。
  2. 対象リポジトリのSettings→Pagesで、SourceをGitHub Actionsにします。
  3. 公式のワークフローを使い、ブランチ名・Hugoの版・公開URLを自分の環境に合わせます。
  4. ソースをコミットしてpushし、Actionsのビルドとdeployの結果を確認します。
  5. 公開URLを匿名で開き、作品ページ、画像、CSS、スマホ表示を確認します。

SSHを使う場合、GitHubへ登録するのは公開鍵です。秘密鍵・アクセストークンや、公開許可のない案件データをリポジトリへ入れないでください。公開対象・無料利用の条件はGitHub Pages公式で確認します。

旧Academicテーマの掲載画面

元記事はacademic-kickstart、config/_default、content/home・authors・project・publication、staticを使った作例でした。生成物をdocsへ出力する設定と、docs内でGitを初期化する記述もありました。現行のActions方式とは別の運用です。

既存サイトを保守する場合は、実際のテーマ・Hugoの版・設定・GitHub PagesのSourceを確認し、バックアップを取ってから変更します。以下の元記事の画像は当時の画面で、現行手順の検証画像ではありません。

コマンドプロンプトで環境変数Pathを設定するコマンドを実行した様子。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
コマンドプロンプトでHugoのバージョン確認コマンドを実行し、バージョン情報が表示された画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
コマンドプロンプトでGitのバージョン確認コマンドを実行した様子。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
テーマのリポジトリをクローンするコマンドを実行した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
ディレクトリを移動し、サブモジュールの初期化と更新コマンドを実行した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
ローカルサーバーを起動するコマンドを実行し、ビルドが完了したコマンドプロンプト画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
ブラウザでローカルサーバーのURLを開き、ローカルサイトを表示した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
ポートフォリオサイトのカスタマイズ対象となるフォルダ構成の表示。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
コンテンツフォルダ内の構成やファイルの編集対象を示した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
GitHubで新しいリポジトリを作成した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
Hugoコマンドを実行して公開用のフォルダを生成したコマンドプロンプト画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
公開用フォルダに移動してGitの初期化コマンドを実行した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
GitHubのリモートリポジトリへプッシュを実行したコマンドプロンプト画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。
GitHub Pagesで正常に公開されたポートフォリオサイトをブラウザで確認した画面。
2019-09の元記事の画面例。現行手順を今回撮影した画像ではありません。

よくある質問:HugoとGitHub Pagesでポートフォリオを作るときのチェックリスト

HugoとGitHub Pagesで、ポートフォリオを公開するには、何が必要ですか?

HugoのビルドとGitHub側の公開設定を、両方用意します。Gitへpushしただけで公開されるとは限りません。Hugo公式のGitHub Pages手順は、GitHub Actionsでビルド・公開する方法です。

この記事の元の作例は、今も使えますか?

元の作例は、Academicテーマを使った過去の構築記録です。現在の新規制作では、利用するテーマが指定するHugoの版・依存関係を確認し、現行の公式手順を使ってください。この記事は、公式資料に基づく準備と確認の案内で、今回の環境で公開まで実行した結果ではありません。

Hugoのバージョンは、どう選びますか?

Hugo公式Quick startとWindowsへのインストールで、必要な版を確認します。テーマによって、Extended、Go、Node.jsなどが必要になるため、テーマのREADMEも確認してください。

古い記事のsetx /MでPathを書き換える方法は、使えますか?

使いません。既存のPathを壊すと、別のツールも起動できなくなるためです。手動でhugo.exeを配置した場合は、Windowsの環境変数の編集画面で、そのフォルダーをユーザーのPathへ追加し、新しいターミナルで確認します。

GitHub Pagesの公開設定は、どうしますか?

対象リポジトリのSettings→Pagesで、SourceをGitHub Actionsにします。公式のワークフローを使い、ブランチ名・Hugoの版・公開URLを自分の環境に合わせて、pushしたあと、Actionsのビルドとdeployの結果を確認します。

リポジトリに入れてはいけないものは?

SSHを使う場合、GitHubへ登録するのは公開鍵です。秘密鍵・アクセストークンや、公開許可のない案件データをリポジトリへ入れないでください。

サービス

Service

デザイン制作に関心がありましたら、ぜひ詳細をご覧ください。

次に学ぶ・作業環境を選ぶ

学習を続けたい方や、作業環境を整えたい方は、目的に合うガイドをご覧ください。

Figmaのおすすめ書籍

Figma用PCの選び方

周辺機器の優先度

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!
目次