Skip to main content

GitHub Pages サイトを作成する

新規または既存のリポジトリ内に、GitHub Pages サイトを作成できます。

GitHub Pagesは、GitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。 詳細については、「GitHub's products」を参照してください。

注: Organization の所有者は、Organization が所有しているリポジトリからの GitHub Pages サイトの公開を制限できます。 詳細については、GitHub Pages サイトの公開の管理に関するページを参照してください。

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

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

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

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

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

  1. ページの右上隅で、[] ドロップダウン メニューを使用して、 [新しいリポジトリ] を選択します。 新しいリポジトリを作成するオプションがあるドロップダウン 1. [所有者] ドロップダウン メニューを使い、リポジトリを所有させたいアカウントを選択します。 [所有者] ドロップダウン メニュー 1. リポジトリの名前と、任意で説明を入力してください。 ユーザーまたは Organization サイトを作成する場合は、リポジトリに <user>.github.io または <organization>.github.io という名前を付ける必要があります。 ユーザーまたは Organization の名前に大文字が含まれている場合は、小文字にする必要があります。 詳細については、「GitHub Pages について」を参照してください。 リポジトリ作成フィールド 1. リポジトリの可視性を選択してください。 詳細については、リポジトリに関する説明を参照してください。 リポジトリの可視性を選択するラジオ ボタン 1. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。 [このリポジトリを README で初期化する] チェックボックス 1. [Create repository] (リポジトリの作成) をクリックします。 リポジトリを作成するボタン

サイトを作成する

サイトを作成する前には、GitHub上にサイトのためのリポジトリを持っていなければなりません。 既存のリポジトリにサイトを作成していない場合は、「サイト用にリポジトリを作成する」を参照してください。

警告: GitHub Pages サイトは、そのリポジトリがプライベートであってもインターネットからのアクセスに対して公開されます。 サイトのリポジトリにセンシティブなデータがあるなら、公開前にそのデータを取り除くのが良いでしょう。 詳細については、リポジトリに関する説明を参照してください。

  1. GitHubで、サイトのリポジトリにアクセスしてください。 1. 使用する公開ソースを決定します。 詳細については、「ご利用の GitHub Pages サイトに合わせた公開元の構成」を参照してください。

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

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

    公開元が GitHub Actions ワークフローである場合、デプロイする成果物には、成果物の最上位レベルにあるエントリ ファイルが含まれている必要があります。 エントリ ファイルをリポジトリに追加する代わりに、ワークフローの実行時に GitHub Actions ワークフローでエントリ ファイルを生成するように選択することもできます。 1. 公開ソースを設定してください。 詳細については、「GitHub Pages サイトの公開元を設定する」を参照してください。 1. リポジトリ名の下の [ 設定] をクリックします。 リポジトリの設定ボタン

  3. In the "Code and automation" section of the sidebar, click Pages.

  4. 公開されたサイトを見るには、"GitHub Pages"の下で、サイトのURLをクリックしてください。 公開されたサイトの URL

    注: サイトに対する変更は、その変更を GitHub にプッシュしてから公開されるまでに、最大 10 分かかることがあります。 GitHub Pages サイトの変更が 1 時間経ってもブラウザーに反映されない場合は、「GitHub Pages サイトの Jekyll ビルド エラーについて」を参照してください。

  5. GitHub Pages サイトは、GitHub Actions ワークフローでビルドされ、デプロイされます。 詳細については、「ワークフロー実行の履歴を表示する」を参照してください。

    注: パブリックリポジトリでは、GitHub Actions は無料です。 使用料は、無料の時間 (分) の毎月の割り当てを超えるプライベート リポジトリと内部リポジトリに適用されます。 詳細については、「使用制限、支払い、管理」を参照してください。

: ブランチから公開しようとしていて、サイトが自動的に公開されていない場合は、管理者アクセス許可と検証済みの電子メール アドレスを持つユーザーが公開ソースにプッシュしていることを確認してください。

次の手順

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

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

サイトを更にカスタマイズするには、Jekyll を使用できます。Jekyll は、GitHub Pages に組み込まれている静的サイトジェネレータです。 詳しくは、「GitHub Pages と Jekyll について」をご覧ください。

参考資料