GitHub Pages
GitHub Pages
概要(サマリー)
GitHub Pages(ギットハブ・ページズ)は、ソースコード管理サービスである GitHub が提供するホスティングサービスである。公開リポジトリなら、無料プランで静的サイトを公開できる。
GitHub上の「リポジトリ(保管庫)」に、作成したHTML、CSS、JavaScriptなどのファイルを保存し、Pagesの公開元を設定すると、Webサイトとして公開(デプロイ)できる。
詳細解説
GitHub Pagesとは何か
自分で作成したWebサイトをインターネット上で誰かに見てもらうには、ファイルを保存しておくための「サーバー」が必要になる。通常はレンタルサーバーを借りて月々の費用を払う必要がある。
GitHub Pagesは、GitHubのリポジトリから作成した静的サイトを公開できるサービスである。公開リポジトリでは無料プランでも利用できるが、非公開リポジトリで使う場合などはプラン条件が関係するため、利用前にGitHub公式の最新条件を確認するとよい。
GitHub Pagesの特徴とメリット
- 公開リポジトリなら始めやすい: 公開リポジトリでは無料プランでも利用でき、サーバー契約なしで静的サイトを公開しやすい。
- Gitとの連携: Git を使ってファイルを更新(プッシュ)するだけで、自動的に公開サイトの中身も最新版に書き換わる。
- SSL(HTTPS)対応: 最初から安全な暗号化通信(
https://)に対応した状態で公開される。 - URLの法則: ユーザーサイト(リポジトリ名が
ユーザー名.github.io)はhttps://ユーザー名.github.io/になる。プロジェクト用のリポジトリはhttps://ユーザー名.github.io/リポジトリ名/になる。
公開するまでの簡単な手順
基本的なHTMLファイルをGitHub Pagesで公開する手順は以下の通りである。画面名や設定項目はGitHub側の更新で変わることがあるため、実際の操作時は公式ドキュメントも確認するとよい。
- ファイルを準備: プロジェクトのトップ(ルート)に入口のファイルを置く。基本は
index.htmlで、index.mdやREADME.mdが入口になることもある。 - GitHubへプッシュ: GitHub上に新しいリポジトリを作成し、コードをプッシュする。
- Pagesの設定を有効化:
- リポジトリの画面で「Settings(設定)」タブを開く。
- 左メニューから「Pages」を選択する。
- 公開元を選ぶ。HTMLをそのまま出すならブランチ(通常は
main)を指定する。ビルドが必要なプロジェクトでは、GitHub Actions のワークフローでビルド結果を公開する方式が公式の手順にもある。
- 公開完了: 数分待つと設定画面に公開されたURLが表示され、アクセス可能になる。反映まで10分ほどかかることがある。
GitHub Pagesで公開できるサイト(静的サイト)
GitHub Pagesで公開できるのは、「静的サイト(Static Site)」に限られる。
- 公開できるもの: HTML、CSS、JavaScript、画像ファイル。ブラウザ側だけで処理が完結するもの。ViteなどでビルドしたReactやVueなどのアプリも、最終的に静的ファイルになっていれば公開できる。ビルド時に Jekyll で Markdown から静的HTMLへ変換する機能もある。
- 公開できないもの: 公開後にサーバー上で動き続けるプログラム。PHP、Python、Node.js のサーバー処理や、WordPress(データベースが必要な動的サイト)は、ファイルを置いただけでは動かない。
カスタムドメインの設定
GitHub Pagesが発行するURL(github.io)ではなく、自分で購入したお好みのURL(カスタムドメイン)を使ってサイトを公開することもできる。
GitHubの設定画面に購入したドメインを入力し、ドメインの購入元(DNSプロバイダ)側でGitHub Pagesを指し示す設定(CNAMEレコードなどの登録)を行うと、オリジナルドメインのWebサイトとして運営できる。DNS設定を誤ると表示できなかったり、別のサイトへ向いたりするため、公式手順に沿って設定することが重要である。
AIコーディングとの関係
AIコーディングにおいて、GitHub Pagesは作成した静的サイトやフロントエンドアプリを公開し、動作テストやポートフォリオとして共有するための有力な手段である。
AIに指示を出す際は、特にビルドツール(Viteなど)と組み合わせる際の設定ミスを事前に防ぐために、以下のように質問すると良い。
- AIへの指示例:
- 「Viteで作ったReactアプリをGitHub Pagesにデプロイしたいです。URLの基準位置がずれてアセットが読み込めない(404エラー)のを防ぐために、
vite.config.jsのbaseの設定方法を教えてください」 - 「ViteプロジェクトをGitHub Pagesに自動デプロイするための GitHub Actions (
.github/workflows/deploy.yml)の書き方を教えてください」
- 「Viteで作ったReactアプリをGitHub Pagesにデプロイしたいです。URLの基準位置がずれてアセットが読み込めない(404エラー)のを防ぐために、
特にViteやReactのプロジェクトをGitHub Pagesにアップロードする際、URLの末尾にリポジトリ名が付くため、base: "/リポジトリ名/" を書いておかないと画像やJavaScriptが読み込まれずに真っ白な画面になってしまうトラブルが初心者に頻出する。
この解決手順をAIに整理させることで、手動でのデプロイや自動化(CI/CD)の設定ミスを減らしやすくなる。ただし、GitHub Actionsの権限、公開元ブランチ、ビルド出力先はプロジェクトごとに違うため、実際の設定画面とログを確認しながら進める必要がある。
よくある勘違い
GitHub PagesではWordPressなどの動的サイトも動く?
動かない。前述の通り、PHPなどのプログラムを実行したりデータベースと接続したりする機能は備わっていないため、WordPressのファイルをそのままアップロードしても「プログラムのコードがテキストとしてそのまま見える」かエラーになる。もしWordPressで作ったブログをどうしても公開したい場合は、静的HTML出力プラグインなどを使って静的化してからアップロードする必要がある。
GitHub Pagesは有料になることがある?
GitHub Free では、公開リポジトリからしか使えない。リポジトリを非公開にすると、公開中のサイトは自動で取り下げられる。非公開リポジトリからサイトを出すには、GitHub Pro、Team、Enterprise Cloud などの対象プランが必要である。その場合でも、サイト自体はインターネットから見えるのが通常である。閲覧者をリポジトリの読み取り権限に限る機能は、GitHub Enterprise Cloud の組織向けである。非公開リポジトリで GitHub Actions を使うと、プランの無料分を超えた計算時間に料金がかかることがある。条件は変わるため、使う前に公式のプラン説明を確認する。
GitHub Pagesに公開すればリポジトリも自動で非公開になる?
ならない。公開リポジトリからGitHub Pagesを公開している場合、リポジトリ内のコードも基本的に公開される。APIキーやパスワードなどの秘密情報を置いてはいけない。非公開リポジトリからPagesを公開する場合でも、公開されたWebサイトの内容はインターネット上から見える前提で扱う必要がある。
まとめ
- GitHub Pagesは、GitHub上のリポジトリから静的サイトを公開できるホスティングサービスである。公開リポジトリなら無料プランで使える
- HTML、CSS、JavaScriptで構成された静的サイトのみが動作し、PHPやWordPressなどの動的システムは動かない
- 公開元の設定やGitHub Actionsを使うことで、変更を公開サイトに反映できる
- Viteなどのプロジェクトを公開する際は、
baseやビルド出力先の設定ミスに注意する - 公開リポジトリ、非公開リポジトリ、カスタムドメインでは条件や注意点が変わるため、公式ドキュメントを確認することが大切である
情報ソース
- GitHub Docs: GitHub Pages についてのドキュメント
- GitHub Docs: What is GitHub Pages?
- GitHub Docs: GitHub's plans
- GitHub Docs: Creating a GitHub Pages site
- GitHub Docs: カスタムドメインと GitHub Pages について
より詳しくAIに聞いてみよう
- Viteで作成したプロジェクトをGitHub Pagesに公開する際、設定ファイル(vite.config.js)に記述すべき
baseプロパティの正しい書き方を教えてください。 - GitHub Pagesで「404 Site not found」エラーが表示された場合、確認すべき設定項目と解決手順を教えてください。
- AIを使って、GitHub PagesにデプロイしたWebアプリで、お名前ドメインやムームードメインなどで取得した「カスタムドメイン」を適用する手順を整理してください。
- GitHub Actionsを活用して、GitHubにプッシュするだけで自動的にビルドとGitHub Pagesへのデプロイが完了する自動化(CI/CD)の仕組みの作り方を教えてください。
- GitHub Pagesのリポジトリを「非公開(Private)」にしたままWebサイトだけを一般公開することは可能ですか?その方法と条件について教えてください。