GitHub ページ サイトの作成

サイト用にリポジトリを作成する

リポジトリを作成することも、自分のサイト用の既存のリポジトリを選ぶこともできます。

リポジトリに対して GitHub Pages サイトを作成したい場合、そのリポジトリ内のすべてのファイルがサイトに関連付けられるわけではないのなら、そのサイトに対して公開元を構成することができます。 たとえば、サイト ソース ファイルを保持する専用のブランチとフォルダーを用意することや、カスタムの GitHub Actions ワークフローを使ってサイト ソース ファイルをビルドして配置することができます。

リポジトリを所有しているアカウントが GitHub Free または Organization 用の GitHub Free を使用している場合、そのリポジトリはパブリックである必要があります。

既存のリポジトリにサイトを作成する場合は、「サイトを作成する」セクションに進んでください。

1. ページの右上隅で を選択し、 [新しいリポジトリ] をクリックします。

   

2. [所有者] ドロップダウン メニューを使い、リポジトリを所有させたいアカウントを選びます。

   メモ

   マネージド ユーザー アカウント は、organization が所有するリポジトリからの GitHub Pages サイトの公開のみを行うことができます。 詳しくは、「GitHub ページの制限」をご覧ください。

3. リポジトリの名前と、任意で説明を入力してください。 ユーザーまたは Organization サイトを作成する場合は、リポジトリに <user>.github.io または <organization>.github.io という名前を付ける必要があります。 ユーザーまたは Organization の名前に大文字が含まれている場合は、小文字にする必要があります。 詳しくは、「GitHub Pages とは」をご覧ください。

4. リポジトリの可視性を選択してください。 詳しくは、「リポジトリについて」をご覧ください。

5. [ README の追加 ] を [オン] に切り替えます。

6. [Create repository] (リポジトリの作成) をクリックします。

サイトを作成する

サイトを作成する前には、GitHub 上にサイト用のリポジトリがある必要があります。 既存のリポジトリにサイトを作成していない場合は、「サイト用にリポジトリを作成する」をご覧ください。

企業が Enterprise Managed Usersを使用しない限り、サイトのリポジトリがプライベートまたは内部の場合でも、 GitHub Pages サイトは既定でインターネット上で一般公開されます。 サイトのアクセス制御を管理することで、サイトをプライベートで公開できます。 それ以外の場合、サイトのリポジトリにセンシティブなデータがあるなら、公開前にそのデータを取り除くのが良いでしょう。 詳細については、「リポジトリについて」および「GitHub ページ サイトの表示設定を変更する」を参照してください。

1. GitHub で、サイトのリポジトリにアクセスしてください。

2. 使用する公開ソースを決定します。 「GitHub Pages サイトの発行ソースの構成」を参照してください。

3. サイト用のエントリ ファイルを作成します。 GitHub Pages は、サイトのエントリ ファイルとして index.html、 index.md、または README.md ファイルを検索します。

   パブリッシュ ソースがブランチとフォルダーの場合、エントリ ファイルはソース ブランチのソース フォルダーの最上位にある必要があります。 たとえば、公開元が /docs ブランチ上の main フォルダーである場合、エントリ ファイルは、/docs という名前のブランチ上の main フォルダー内に配置する必要があります。

   発行元が GitHub Actions ワークフローの場合、デプロイする成果物には、成果物の最上位レベルのエントリ ファイルを含める必要があります。 エントリ ファイルをリポジトリに追加する代わりに、ワークフローの実行時に GitHub Actions ワークフローでエントリ ファイルを生成するように選択できます。

4. 公開ソースを設定してください。 「GitHub Pages サイトの発行ソースの構成」を参照してください。

5. GitHub Pages サイトは、GitHub Actions ワークフローを使用して構築および展開されます。 詳しくは、「ワークフロー実行の履歴を表示する」をご覧ください。

   メモ

   GitHub Actions はパブリック リポジトリでは無料です。 使用料は、無料の時間 (分) の毎月の割り当てを超えるプライベート リポジトリと内部リポジトリに適用されます。 詳しくは、「課金と使用」をご覧ください。

公開されたサイトを表示する

1. リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

   

2. サイドバーの「コード、計画、自動化」セクションで、「ページ」をクリックします。

3. 必要に応じて、プライベートまたは内部リポジトリからプロジェクトサイトを公開する場合、サイトの可視性を選択します。 [GitHub Pages] で、[表示] ドロップダウン メニューを選択し、[パブリック] または [プライベート] を選択します。

1. 発行済みサイトを表示するには、[GitHub Pages] で [サイト アクセス] をクリックします。

静的サイト生成ツール

GitHub Pages は、リポジトリにプッシュするすべての静的ファイルを発行します。 静的ファイルを自分で作成することも、静的サイトジェネレータでサイトをビルドすることも可能です。 ローカルまたは別のサーバー上で独自のビルドプロセスをカスタマイズすることもできます。

カスタム ビルド プロセスまたは Jekyll 以外の静的サイト ジェネレーターを使用する場合は、サイトをビルドして発行する GitHub Actions ワークフローを記述できます。 GitHub には、複数の静的サイト ジェネレーター用のワークフロー テンプレートが用意されています。 詳しくは、「GitHub Pages サイトの発行ソースの構成」をご覧ください。

ソース ブランチからサイトを発行する場合、 GitHub Pages は Jekyll を使用して既定でサイトをビルドします。 Jekyll 以外の静的サイト ジェネレーターを使用する場合は、代わりにサイトをビルドして発行する GitHub Actions を記述することをお勧めします。 それ以外の場合は、公開元のルートに .nojekyll という名前の空のファイルを作成して Jekyll ビルド プロセスを無効にし、静的サイト ジェネレーターの指示に従ってローカルでサイトをビルドします。

MIME の種類 GitHub Pages

MIME タイプとは、ブラウザがリクエストするファイルの性質やフォーマットに関する情報を提供するため、サーバーがブラウザに送信するヘッダのことです。 GitHub Pages では、何千ものファイル拡張子にわたって 750 を超える MIME の種類がサポートされています。 サポートされている MIME の種類の一覧は、mime-db プロジェクトから生成されます。

ファイルごとまたはリポジトリごとにカスタム MIME の種類を指定することはできませんが、 GitHub Pagesで使用するために MIME の種類を追加または変更できます。 詳細については、mime-db のコントリビューション ガイドラインを参照してください。

次のステップ

新しいファイルを追加で作成することにより、ページを追加できます。 各ファイルは、公開元と同じディレクトリ構造で、サイト上に表示されます。 たとえば、プロジェクト サイトの発行元が gh-pages ブランチで、gh-pages ブランチに /about/contact-us.md という名前の新しいファイルを作成した場合、ファイルは `https://.github.io//about/contact-us.html' で使用できます。

また、サイトの見た目をカスタマイズするため、テーマを追加できます。 詳しくは、「Jekyll を使用して GitHub Pages サイトにテーマを追加する」をご覧ください。

参考資料

• 「GitHub ページと Jekyll について」。
• GitHub Pages サイトの Jekyll ビルド エラーのトラブルシューティング
• リポジトリ内のブランチの管理
• 新しいファイルの作成
• GitHub ページ サイトの 404 エラーのトラブルシューティング