.github.io(GitHub Pages)は、GitHubのリポジトリから直接静的ウェブサイトを無料でホストできるサービスです。 [1, 2] 正しい使い方の核となるのは、リポジトリの命名規則と公開設定(Pages設定)の2点です。
個人のプロフィールサイトやポートフォリオを作成する場合、リポジトリ名は以下の形式にする必要があります。
- リポジトリ名: {ユーザー名}.github.io
- 例:あなたのユーザー名が taro なら taro.github.io
- 重要: ユーザー名と完全に一致させる必要があります。大文字が含まれる場合は小文字で入力してください。 [3, 4, 5, 6, 7]
サイトのトップページとして表示されるファイルは、リポジトリのルート(一番上の階層)に置く必要があります。 [1, 8]
- 必須ファイル: index.html(または index.md / README.md) [9, 10]
- 構成例:
- index.html
- style.css
- script.js
- /images/(画像フォルダなど)
リポジトリを作成し、ファイルをアップロード(またはプッシュ)した後の設定手順です。 [7, 11]
- GitHub上の対象リポジトリを開き、「Settings」タブをクリックします。 [4, 12]
- 左サイドメニューの「Code and automation」セクションにある「Pages」を選択します。 [7, 12]
- 「Build and deployment」セクションの「Source」を 「Deploy from a branch」 に設定します。 [12]
- 「Branch」のドロップダウンから公開したいブランチ(通常は main)を選択し、その横のフォルダ設定が /(root) になっていることを確認して「Save」をクリックします。 [10, 12]
- 数分待つと、画面上部に「Your site is live at...」というメッセージとURLが表示されます。 [12, 13]
Getting Started with GitHub Pages, YouTube · Net Ninja · 2021 M02 19
- カスタムドメイン: 独自ドメインを適用することも可能です。「Pages」設定内の「Custom domain」にドメイン名を入力し、DNS設定(CNAMEレコード等)を行います。 [14, 15]
- 自動更新: 指定したブランチ(mainなど)にファイルをプッシュするだけで、サイトの内容は自動的に更新されます。 [16]
- 制限: GitHub Pagesは静的サイト専用です。PHPやPython(Django/Flask)などのサーバーサイド言語は動作しません。 [9]
- 公開範囲: 無料プランの場合、リポジトリを Public(公開) に設定する必要があります。 [6, 17]
さらに詳しく知りたい特定のステップ(例:独自ドメインの紐付けやReactなどのフレームワークを使った公開方法)はありますか?
[1] https://www.youtube.com [2] https://www.youtube.com [3] https://docs.github.com [4] https://docs.github.com [5] https://docs.github.com [6] https://saycon.co.jp [7] https://www.plainconcepts.com [8] https://mukai-lab.info [9] https://www.youtube.com [10] https://github.com [11] https://career.levtech.jp [12] https://docs.github.com [13] https://note.com [14] https://zenn.dev [15] https://www.folklore.place [16] https://www.issoh.co.jp [17] https://qiita.com