GitHub Pagesについて
GitHub Pages は、GitHub Enterprise のリポジトリから HTML、CSS、および JavaScript ファイル を直接取得し、任意でビルドプロセスを通じてファイルを実行し、ウェブサイトを公開できる静的なサイトホスティングサービスです。 GitHub Pages サイトの例については、GitHub Pages サンプル集で見ることができます。
作成方法については、「GitHub Pages サイトを作成する」を参照してください。
GitHub Pages サイトの種類
GitHub Pages サイトには、3 つの種類があります。プロジェクト、ユーザ、そして Organization です。 プロジェクトサイトは、JavaScript ライブラリやレシピ集など、GitHub Enterprise の特定のプロジェクトに関するものです。 ユーザおよび Organization サイトは、特定の GitHub Enterprise に関するものです。
ユーザサイトを公開するには、<user>.<hostname> という名前のユーザアカウントが所有するリポジトリを作成する必要があります。 Organization サイトを公開するには、 <organization>.<hostname>という名前のOrganizationが所有するリポジトリを作成する必要があります。
プロジェクトサイトのソースファイルは、プロジェクトと同じリポジトリに保存されます。
GitHub Enterprise アカウントごとに、ユーザまたは Organization サイトを 1 つだけ作成できます。 プロジェクトサイトの数については、Organization アカウントでもユーザアカウントでも、無制限です。
サイトが利用できる URL については、使用している GitHub Enterprise Serverインスタンス で Subdomain Isolation を有効にしているかどうかで異なります。
| サイトの種類 | Subdomain Isolation が有効 | Subdomain isolation が無効 |
|---|---|---|
| ユーザ |
http(s)://pages.<hostname>/<username>/<repository>/ | http(s)://<hostname>/pages/<username>/<repository>/ | Organization | http(s)://pages.<hostname>/<organization>/<repository>/ | http(s)://<hostname>/pages/<organization>/<repository>/ | ユーザアカウントが所有するプロジェクトサイト | 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 サイトの公開元
The publishing source for your GitHub Pages site is the branch and folder where the source files for your site are stored. All sites have a default publishing source, and project sites have additional publishing sources available.
警告: サイト管理者がPublic Pagesを有効化したなら、そのリポジトリがプライベートの場合であっても、GitHub Pagesサイトはインターネット上でパブリックにアクセスできるようになります。 サイトのリポジトリにセンシティブなデータがあるなら、公開前にそれを取り除くのが良いでしょう。 詳しい情報については「アプライアンス上でのGitHub Pagesの設定」及び「リポジトリの可視性について」を参照してください。
ユーザおよび Organization サイトの、デフォルトの公開元は master ブランチです。 ユーザまたは Organization サイトのリポジトリに master ブランチがある場合、サイトはそのブランチから自動的に公開されます。 ユーザや Organization サイトで、別の公開元を選ぶことはできません。
プロジェクトサイトの、デフォルトの公開元は gh-pages ブランチです。 プロジェクトサイトのリポジトリに gh-pages ブランチがある場合、サイトはそのブランチから自動的に公開されます。
プロジェクトサイトは、master ブランチまたは master ブランチ場の /docs フォルダから公開することもできます。 これらの公開元からサイトを公開するには、別の公開元を設定する必要があります。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。
master ブランチ上の /docs フォルダを公開元として選択する場合、サイトを公開するため、GitHub Pages は全てのファイルを /docs フォルダから読み取ります。
デフォルトブランチがmasterまたはgh-pagesではない場合でも、他のブランチからはプロジェクトサイトを公開することはできません。
静的サイトジェネレータ
GitHub Pages は、リポジトリにプッシュされたあらゆる静的ファイルを公開します。 静的ファイルを自分で作成することも、静的サイトジェネレータでサイトをビルドすることも可能です。 ローカルまたは別のサーバー上で独自のビルドプロセスをカスタマイズすることもできます。 GitHub Pages に組み込まれている静的サイトジェネレータで、ビルドプロセスを容易化できる Jekyll のご利用をおすすめします。 詳しい情報については、「GitHub Pages と Jekyll」を参照してください。
GitHub Pages は、デフォルトでは Jekyll を使ってサイトを構築します。 Jekyll 以外の静的サイトジェネレータを使いたい場合、公開元のルートに .nojekyll という空のファイルを作成し、お使いの静的サイトジェネレータの指示に従ってローカルでサイトをビルドします。
GitHub Pages は、PHP、Ruby、Python などのサーバーサイド言語はサポートしていません。
GitHub Pages を使用するためのガイドライン
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 Learning Lab の GitHub Pages
- "GitHub Pages"