GitHub Pages サイトを作成する

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

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

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

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

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

ページの右上隅で、[] ドロップダウンメニューを使用して、 [新しいリポジトリ] を選択します。

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

サイトを作成する

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

警告: サイト管理者がパブリックページを有効にしている場合、サイトのリポジトリがプライベートまたは内部であっても、GitHub Pages サイトはインターネット上で一般公開されます。サイトのリポジトリにセンシティブなデータがあるなら、公開前にそのデータを取り除くのが良いでしょう。詳細については、「Enterprise 向けの GitHub Pages を設定する」および「リポジトリについて」を参照してください。

GitHub Enterprise Serverで、サイトのリポジトリにアクセスしてください。 1. 使用する公開ソースを決定します。詳しくは、「GitHub Pages サイトの公開元を設定する」を参照してください。
サイト用のエントリファイルを作成します。 GitHub Pages では、サイト用のエントリファイルとして index.html、index.md、または README.md ファイルを検索します。

エントリファイルは、選択した公開元の最上位レベルに配置する必要があります。たとえば、公開元が main ブランチ上の /docs フォルダーである場合、エントリファイルは、main という名前のブランチ上の /docs フォルダー内に配置する必要があります。 1. 公開ソースを設定してください。詳しくは、「GitHub Pages サイトの公開元を設定する」を参照してください。 1. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーで、 [ページ] をクリックします。
公開されたサイトを表示するには、[GitHub Pages] の下で [ サイトにアクセスする] をクリックします。

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

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

次の手順

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

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

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

GitHub Pages サイトを作成する

この記事の内容

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

サイトを作成する

次の手順

参考資料