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

GitHub Pages について

GitHub Pages を使って、あなたやあなたの Organization、またはあなたのプロジェクトについてのウェブサイトを、GitHub リポジトリから直接ホストできます。

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

GitHub Pages について

GitHub Pages は、GitHub のリポジトリから HTML、CSS、および JavaScript ファイル を直接取得し、任意でビルドプロセスを通じてファイルを実行し、ウェブサイトを公開できる静的なサイトホスティングサービスです。 GitHub Pages サイトの例については、GitHub Pages サンプル集で見ることができます。

GitHub のgithub.io ドメインまたはご自身のカスタムドメインで、サイトをホストできます。 詳細は「GitHub Pages でカスタムドメインを使用する」を参照してください。

プロジェクトサイトがGitHub Enterprise Cloudを使用するOrganizationが所有するプライベートもしくはインターナルリポジトリから公開されるなら、そのサイトのアクセス制御を管理できます。 For more information, see "Changing the visibility of your GitHub Pages site."

作成方法については、「GitHub Pages サイトを作成する」を参照してください。

Organization owners can disable the publication of GitHub Pages sites from the organization's repositories. For more information, see "Managing the publication of GitHub Pages sites for your organization."

GitHub Pages サイトの種類

GitHub Pages サイトには、3 つの種類があります。プロジェクト、ユーザ、そして Organization です。 プロジェクトサイトは、JavaScript ライブラリやレシピ集など、GitHub の特定のプロジェクトに関するものです。 ユーザおよび Organization サイトは、特定の GitHub に関するものです。

ユーザサイトを公開するには、<username>.github.io という名前のユーザアカウントが所有するリポジトリを作成する必要があります。 Organization サイトを公開するには、 <organization>.github.io という名前の Organization が所有するリポジトリを作成する必要があります。 カスタムドメインを使用している場合を除き、ユーザサイトと Organization サイトは http(s)://<username>.github.io または http(s)://<organization>.github.io で利用できます。

プロジェクトサイトのソースファイルは、プロジェクトと同じリポジトリに保存されます。 カスタムドメインを使用している場合を除き、プロジェクトサイトは http(s)://<username>.github.io/<repository> または http(s)://<organization>.github.io/<repository> で利用できます。

サイトを非公開で公開する場合、サイトの URL が異なります。 For more information, see "Changing the visibility of your GitHub Pages site."

カスタムドメインがサイトの URL に与える影響に関する詳しい情報については、「カスタムドメインと GitHub Pages について」を参照してください。

GitHub のアカウントごとに作成できるユーザまたは Organization サイトは 1 つだけです。 プロジェクトサイトの数については、Organization アカウントでもユーザアカウントでも、無制限です。

GitHub Pages サイトの公開元

GitHub Pages サイトの公開元は、サイトのソースファイルが保存されているブランチまたはフォルダです。

警告: GitHub Pagesサイトはデフォルトで、サイトのリポジトリがプライベートもしくはインターナルであっても、インターネット上で公開利用できます。 プロジェクトサイトがGitHub Enterprise Cloudを使用するOrganizationが所有するプライベートもしくはインターナルリポジトリから公開されるなら、そのサイトのアクセス制御を管理できます。そうでない場合は、もしセンシティブなデータがサイトのリポジトリにあるなら、公開前にそのデータを削除しておくとよいでしょう。 詳しい情報については、「リポジトリの可視性について」及び「GitHub Pagesサイトの可視性の変更」を参照してください。

デフォルトの公開元がリポジトリに存在する場合、GitHub Pages はそこから自動的にサイトを公開します。 ユーザサイトと Organization サイトのデフォルトの公開元は、リポジトリのデフォルトブランチのルートです。 プロジェクトサイトのデフォルトの公開元は、gh-pages ブランチのルートです。

サイトのソースファイルを別の場所に保持する場合は、サイトの公開元を変更できます。 リポジトリ内の任意のブランチから、そのブランチのリポジトリのルート、/、またはそのブランチの /docs フォルダからサイトを公開できます。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。

公開元としていずれかのブランチの /docs フォルダを選択した場合、GitHub Pages は/docs フォルダから CNAME ファイルを含むサイトを公開するためのすべてを読み取ります。たとえば、GitHub Pages 設定を使用してカスタムドメインを編集すると、カスタムドメインは /docs/CNAME に書き込みます。 CNAME ファイルに関する詳しい情報については、「GitHub Pages サイト用のカスタムドメインを管理する」を参照してください。

静的サイトジェネレータ

GitHub Pages は、リポジトリにプッシュされたあらゆる静的ファイルを公開します。 静的ファイルを自分で作成することも、静的サイトジェネレータでサイトをビルドすることも可能です。 ローカルまたは別のサーバー上で独自のビルドプロセスをカスタマイズすることもできます。 GitHub Pages に組み込まれている静的サイトジェネレータで、ビルドプロセスを容易化できる Jekyll のご利用をおすすめします。 詳しい情報については、「GitHub Pages と Jekyll」を参照してください。

GitHub Pages は、デフォルトでは Jekyll を使ってサイトを構築します。 Jekyll 以外の静的サイトジェネレータを使いたい場合、公開元のルートに .nojekyll という空のファイルを作成し、お使いの静的サイトジェネレータの指示に従ってローカルでサイトをビルドします。

GitHub Pages は、PHP、Ruby、Python などのサーバーサイド言語はサポートしていません。

GitHub Pages を使用するためのガイドライン

  • 2016 年 6 月 15 日以降に作成され、github.io ドメインを使用して作成された GitHub Pages サイトは、HTTPS 経由で配信されます。 2016 年 6 月 15 日までにサイトを作成した場合は、サイトへのトラフィックに対して、HTTPS サポートを有効にすることができます。 詳しい情報については「HTTPS でGitHub Pagesサイトをセキュアにする」を参照してください。
  • GitHub Pages サイトは、パスワードやクレジットカード番号といった機密情報のやりとりに使うべきではありません。
  • GitHub Pages の使用には、転売禁止を含めて、GitHub 利用規約が適用されます。

使用制限

GitHub Pages サイトには、次の使用制限があります:

  • GitHub Pages ソースリポジトリには、1GB の推奨上限があります。詳しい情報については、「私のディスク容量はいくつですか?」を参照してください。

  • 公開されたGitHub Pagesのサイトは1GB以上であってはなりません。

  • GitHub Pages サイトには、月当たり 100GB のソフトな帯域幅制限があります。

  • GitHub Pages サイトには、時間当たり 10 ビルドのソフトな制限があります。

あなたのサイトがこれらの使用割当量を超えている場合、あなたのサイトにサービスを提供できないか、GitHub Supportあるいは GitHub Premium Support から、あなたのサイトが当社のサーバーに与える影響を減らす方法を示唆するメールが届くことがあります。そうした方法の例としては、サードパーティのコンテンツ配信ネットワーク (CDN) をサイトの前に配置したり、リリースなどの他の GitHub 機能を利用したり、ニーズに合った別のホスティングサービスに移行したりすることなどが挙げられます。

禁止される用途

GitHub Pages は、オンラインビジネス、eコマースサイト、主に商取引の円滑化またはサービスとしての商用ソフトウェアの提供 (SaaS) のどちらかを目的とする、その他のウェブサイトを運営するための無料のウェブホスティングサービスとしての使用を意図したものではなく、またそのような使用を許可するものでもありません。

In addition, GitHub does not allow GitHub Pages to be used for certain purposes or activities. 禁止されている用途のリストについては、「GitHub の GitHub Pages に関する追加製品の利用規約」を参照してください。

GitHub Pages での MIME タイプ

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

ファイルごと、リポジトリごとにカスタム MIME タイプを指定することはできませんが、GitHub Pages で使う MIME タイプを追加や変更することは可能です。 詳しい情報については、「mime-db コントリビューションガイドライン」を参照してください。

参考リンク

このドキュメントは役立ちましたか? プライバシーポリシー

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

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

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

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

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

GitHubコミュニティで質問する サポートへの連絡