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

GitHub Pages について

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

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

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

GitHub Pages について

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

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

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

GitHub Pages サイトの種類

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

ユーザおよび Organization サイトは、常に <user>.github.io または <organization>.github.io と名付けられたリポジトリから公開されます。 カスタムドメインを設定していない場合、ユーザおよび Organization サイトは http(s)://<username>.github.io または http(s)://<organization>.github.io から利用できます。

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

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

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

注釈: Repositories using theレガシーの <user>.github.com 命名規則を使用しているリポジトリも公開されますが、訪問者は http(s)://<username>.github.com からhttp(s)://<username>.github.io にリダイレクトされます。 <user>.github.com<user>.github.io の両方のリポジトリが存在する場合、 <user>.github.io のリポジトリのみが公開されます。

GitHub Pages サイトの公開元

GitHub Pages サイトの公開元は、サイトのソースファイルが保存されている場所のブランチまたはフォルダです。 すべてのサイトにはデフォルトの公開元があり、プロジェクトサイトでは追加の公開元も利用できます。

Warning: GitHub Pages sites are publicly available on the internet, even if their repositories are private. If you have sensitive data in your site's repository, you may want to remove it before publishing.

ユーザおよび Organization サイトの、デフォルトの公開元は master ブランチです。 ユーザまたは Organization サイトのリポジトリに master ブランチがある場合、サイトはそのブランチから自動的に公開されます。 ユーザや Organization サイトで、別の公開元を選ぶことはできません。

プロジェクトサイトの、デフォルトの公開元は gh-pages ブランチです。 プロジェクトサイトのリポジトリに gh-pages ブランチがある場合、サイトはそのブランチから自動的に公開されます。

プロジェクトサイトは、master ブランチまたは master ブランチ場の /docs フォルダから公開することもできます。 これらの公開元からサイトを公開するには、別の公開元を設定する必要があります。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。

master ブランチ上の /docs フォルダを公開元として選択する場合、サイトを公開するため、GitHub Pages は、CNAME ファイルも含めた全てのファイルを /docs フォルダから読み取ります。たとえば、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) のどちらかを目的とるす、その他のウェブサイトを運営するための無料のウェブホスティングサービスとしての使用を意図したものではなく、またそのような使用を許可するものでもありません。

さらに、GitHub Pages サイトでは、以下を禁じています:

  • 法律違反、またはそれ以外で当社の利用規約またはコミュニティガイドラインに反しているコンテンツまたは行為
  • 暴力的または脅迫的なコンテンツまたは活動
  • 過剰な自動一括活動 (スパム送信など)
  • GitHub ユーザまたは GitHub サービスを危険にさらす活動
  • 攻略法詐欺
  • 性的・わいせつなコンテンツ
  • 自分の素性またはサイトの目的を誤って表現しているコンテンツ

あなたの用途または意図された用途がこれらのカテゴリに該当するかどうかについて質問がある場合は、GitHub Supportまたは GitHub Premium Support にお問い合わせください。

GitHub Pages での MIME タイプ

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

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

参考リンク

担当者にお尋ねください

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

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