GitHub Pages サイトを作成する

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

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

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

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

サイトが独立プロジェクトなら、サイトのソースコードを保存するために新しいリポジトリを作成できます。 サイトが既存のプロジェクトと関連しているなら、ソースコードをそのサイトのプロジェクトのリポジトリのデフォルトブランチの/docs、もしくは他のブランチに追加できます。たとえば、すでにGitHub上にあるプロジェクトのためのドキュメンテーションを公開するサイトを作成しているなら、そのサイトのソースコードをプロジェクトと同じリポジトリに保存したいでしょう。

リポジトリを所有しているアカウントがGitHub FreeもしくはOrganization用のGitHub Freeを使用しているなら、そのリポジトリはパブリックでなければなりません。

既存のリポジトリにサイトを作成したいのなら、サイトの作成セクションまでスキップしてください。

  1. ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。 新しいリポジトリを作成する選択肢を持つドロップダウン
  2. Owner(オーナー)ドロップダウンメニューを使い、リポジトリを所有したいアカウントを選択してください。 [Owner] ドロップダウンメニュー
  3. リポジトリの名前と、任意で説明を入力してください。 ユーザもしくはOrganizationのサイトを作成しているなら、リポジトリは<user>.github.ioもしくは<organization>.github.ioという名前でなければなりません。 If your user or organization name contains uppercase letters, you must lowercase the letters. 詳しい情報については「GitHub Pagesについて」を参照してください。 リポジトリ作成フィールド
  4. リポジトリの可視性を選択してください。 For more information, see "About repositories." リポジトリの可視性を選択するラジオボタン
  5. [Initialize this repository with a README] を選択します。 [Initialize this repository with a README] チェックボックス
  6. [Create repository] をクリックします。 Button to create repository

サイトを作成する

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

警告: GitHub Pagesサイトはデフォルトで、サイトのリポジトリがプライベートもしくはインターナルであっても、インターネット上で公開利用できます。プロジェクトサイトがGitHub Enterprise Cloudを使用するOrganizationが所有するプライベートもしくはインターナルリポジトリから公開されるなら、そのサイトのアクセス制御を管理できます。 In an enterprise with managed users, all GitHub Pages sites are privately published.そうでない場合は、もしセンシティブなデータがサイトのリポジトリにあるなら、公開前にそのデータを削除しておくとよいでしょう。 For more information, see "About repositories" and "Changing the visibility of your GitHub Pages site."

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

  2. どの公開ソースを使いたいか、判断してください。 詳しい情報については「GitHub Pagesについて」を参照してください。

  3. 選択した公開元が既に存在する場合、公開元に移動します。 選択した公開元がまだ存在しない場合は、公開元を作成します。

  4. 公開元のルートに、サイトのメインページに表示したいコンテンツを含んだ、index.md という名前の新しいファイルを作成します。

  5. 公開ソースを設定してください。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。

  6. リポジトリ名の下で Settings(設定)をクリックしてください。 リポジトリの設定ボタン

  7. 左のサイドバーでPages(ページ)をクリックしてください。 左のサイドバーのPageタブ

  8. あるいは、プロジェクトサイトをGitHub Enterprise Cloudを使用するOrganizationが所有しているプライベートもしくはインターナルリポジトリから公開している場合、サイトの可視性を選択してください。 "GitHub Pages"の下で、GitHub Pages visibility(GitHub Pagesの可視性)ドロップダウンメニューを選択し、可視性をクリックしてください。 詳しい情報については「GitHub Pagesサイトの可視性の変更」をクリックしてください。 サイトの可視性を選択するドロップダウンメニュー

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

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

ノート: サイトが自動的に公開されない場合は、管理権限と認証済みメールアドレスを持つ人が公開ソースにプッシュしていることを確認してください。

次のステップ

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

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

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

参考リンク

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?