👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Stay tuned for a blog post later today.


ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: Enterprise Server 2.19

GitHub Pages サイトを作成する

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

GitHub Pagesは、GitHub Free 及びGitHub FreeのOrganizationではパブリックリポジトリでのみ使用でき、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Server ではパブリックおよびプライベートリポジトリで使用できます。

ここには以下の内容があります:

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

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

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

警告: サイト管理者がPublic Pagesを有効化したなら、そのリポジトリがプライベートの場合であっても、GitHub Pagesサイトはインターネット上でパブリックにアクセスできるようになります。 サイトのリポジトリにセンシティブなデータがあるなら、公開前にそれを取り除くのが良いでしょう。 詳しい情報については「アプライアンス上でのGitHub Pagesの設定」及び「リポジトリの可視性について」を参照してください。

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

サイトを作成する

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

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

  2. プロジェクトサイトを作成しているなら、使いたい公開ソースを決めてください。 ユーザもしくはOrganizationのサイトを作成しているなら、サイトのソースコードはmasterブランチに保存しなければなりません。 詳しい情報については「GitHub Pagesについて」を参照してください。

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

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

  5. プロジェクトサイトにデフォルトではない公開ソースを使っているなら、公開ソースを設定してください。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。

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

    リポジトリの設定ボタン

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

    公開されたサイトのURL

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

ノート: サイトのソースファイルがデフォルトの公開ソース、すなわちユーザ及びOrganizationのサイトであればmaster、プロジェクトのサイトであればgh-pagesにありながら、サイトが自動的に公開されない場合は、管理権限と認証済みメールアドレスを持つ人がデフォルトの公開ソースにプッシュしていることを確認してください。

次のステップ

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

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

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

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください