GitHub Pages について

You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a repository on your GitHub Enterprise Server instance.

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

GitHub Pages について

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

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

Organizationのオーナーは、OrganizationのリポジトリからのGitHub Pagesサイトの公開を無効化できます。 詳しい情報については「OrganizationのGitHub Pagesサイトの公開の管理」を参照してください。

GitHub Pages サイトの種類

GitHub Pages サイトには、3 つの種類があります。プロジェクト、ユーザ、そして Organization です。 プロジェクトサイトは、JavaScript ライブラリやレシピ集など、GitHub Enterprise Server の特定のプロジェクトに関するものです。 User and organization sites are connected to a specific account on your GitHub Enterprise Server instance.

ユーザサイトを公開するには、<username>.<hostname> という名前のユーザアカウントが所有するリポジトリを作成する必要があります。 Organization サイトを公開するには、 <organization>.<hostname>という名前のOrganizationが所有するリポジトリを作成する必要があります。

プロジェクトサイトのソースファイルは、プロジェクトと同じリポジトリに保存されます。

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

サイトが利用できる URL については、your GitHub Enterprise Server instance で Subdomain Isolation を有効にしているかどうかで異なります。

サイトの種類Subdomain Isolation が有効Subdomain isolation が無効
ユーザ

http(s)://pages.<hostname>/<username> | http(s)://<hostname>/pages/<username> | Organization | http(s)://pages.<hostname>/<organization> | http(s)://<hostname>/pages/<organization> | ユーザアカウントが所有するプロジェクトサイト | http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ Organization アカウントが所有するプロジェクトサイト | http(s)://pages.<hostname>/<orgname>/<repository>/ | http(s)://<hostname>/pages/<orgname>/<repository>/

詳しい情報については、 「Subdomain Isolation を有効化する」を参照するか、サイト管理者にお問い合わせください。

GitHub Pages サイトの公開元

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

Warning: If your site administrator has enabled Public Pages, GitHub Pages sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "Configuring GitHub Pages for your enterprise" and "About repositories."

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

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

公開元としていずれかのブランチの /docs フォルダを選択した場合を含むサイトを公開するためのすべてを読み取ります。

静的サイトジェネレータ

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

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

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

Limits on use of GitHub Pages

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

In addition, your use of GitHub Pages is subject to the GitHub Terms of Service, including the restrictions on get rich quick schemes, sexually obscene content, and violent or threatening content or activity.

使用制限

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

  • GitHub Pages ソースリポジトリには、1GB の推奨上限があります。
  • 公開されたGitHub Pagesのサイトは1GB以上であってはなりません。

GitHub Pages での MIME タイプ

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

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

参考リンク

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

プライバシーポリシー

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

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

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

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

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