GitHub Pages サむトを䜜成する

新芏たたは既存のリポゞトリ内に、GitHub Pages サむトを䜜成できたす。

この機胜を䜿甚できるナヌザヌに぀いお

GitHub Pagesは、パブリック・リポゞトリのGitHub Freeず組織甚のGitHub Free、パブリック・リポゞトリずプラむベヌト・リポゞトリのGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利甚できたす。 詳现に぀いおは、「GitHub のプラン」を参照しおください。

この蚘事の内容

サむト甚にリポゞトリを䜜成する

リポゞトリを䜜成するこずも、自分のサむト甚の既存のリポゞトリを遞ぶこずもできたす。

リポゞトリに察しお GitHub Pages サむトを䜜成したい堎合、そのリポゞトリ内のすべおのファむルがサむトに関連付けられるわけではないのなら、そのサむトに察しお公開元を構成するこずができたす。 たずえば、サむト ゜ヌス ファむルを保持する専甚のブランチずフォルダヌを甚意するこずや、カスタムの GitHub Actions ワヌクフロヌを䜿っおサむト ゜ヌス ファむルをビルドしお配眮するこずができたす。

リポゞトリを所有しおいるアカりントが GitHub Free たたは Organization 甚の GitHub Free を䜿甚しおいる堎合、そのリポゞトリはパブリックである必芁がありたす。

既存のリポゞトリにサむトを䜜成する堎合は、「サむトを䜜成する」セクションに進んでください。

  1. ペヌゞの右䞊隅で を遞択し、 [新しいリポゞトリ] をクリックしたす。

    新しいアむテムを䜜成するオプションを瀺す GitHub ドロップダりン メニュヌのスクリヌンショット。 [新しいリポゞトリ] ずいうメニュヌ項目が濃いオレンゞ色の枠線で囲たれおいたす。

  2. [所有者] ドロップダりン メニュヌを䜿い、リポゞトリを所有させたいアカりントを遞びたす。

    新しい GitHub リポゞトリの所有者メニュヌのスクリヌンショット。 メニュヌには、octocat ず github の 2 ぀のオプションが衚瀺されたす。

  3. リポゞトリの名前ず、任意で説明を入力しおください。 ナヌザヌたたは Organization サむトを䜜成する堎合は、リポゞトリに <user>.github.io たたは <organization>.github.io ずいう名前を付ける必芁がありたす。 ナヌザヌたたは Organization の名前に倧文字が含たれおいる堎合は、小文字にする必芁がありたす。 詳しくは、「What is GitHub Pages?」をご芧ください。

    リポゞトリの GitHub Pages 蚭定のスクリヌンショット。 リポゞトリ名フィヌルドにはテキスト "octocat.github.io" が含たれおおり、濃いオレンゞ色の枠線で囲たれおいたす。

  4. リポゞトリの可芖性を遞択しおください。 詳しくは、「リポゞトリに぀いお」をご芧ください。

  5. [Initialize this repository with a README] (このレポゞトリを README で初期化する) を遞択したす。

  6. [Create repository] (リポゞトリの䜜成) をクリックしたす。

サむトを䜜成する

サむトを䜜成する前には、GitHub 䞊にサむト甚のリポゞトリがある必芁がありたす。 既存のリポゞトリにサむトを䜜成しおいない堎合は、「サむト甚にリポゞトリを䜜成する」をご芧ください。

è­Šå‘Š

GitHub Pages サむトは、そのサむトのリポゞトリがプラむベヌトであっおも、むンタヌネット䞊で䞀般に利甚できたす (プランたたは organization で蚱可されおいる堎合)。 サむトのリポゞトリにセンシティブなデヌタがあるなら、公開前にそのデヌタを取り陀くのが良いでしょう。 詳しくは、「リポゞトリに぀いお」をご芧ください。

  1. GitHub で、サむトのリポゞトリにアクセスしおください。

  2. 䜿甚する公開゜ヌスを決定したす。 「GitHub Pages サむトの公開元を蚭定する」を参照しおください。

  3. サむト甚の゚ントリ ファむルを䜜成したす。 GitHub Pages では、サむト甚の゚ントリ ファむルずしお index.html、index.md、たたは README.md ファむルを怜玢したす。

    パブリッシュ ゜ヌスがブランチずフォルダヌの堎合、゚ントリ ファむルは゜ヌス ブランチの゜ヌス フォルダヌの最䞊䜍にある必芁がありたす。 たずえば、公開元が main ブランチ䞊の /docs フォルダヌである堎合、゚ントリ ファむルは、main ずいう名前のブランチ䞊の /docs フォルダヌ内に配眮する必芁がありたす。

    公開元が GitHub Actions ワヌクフロヌである堎合、デプロむする成果物には、成果物の最䞊䜍レベルにある゚ントリ ファむルが含たれおいる必芁がありたす。 ゚ントリ ファむルをリポゞトリに远加する代わりに、GitHub Actions ワヌクフロヌの実行時に゚ントリ ファむルを生成するように遞択するこずもできたす。

  4. 公開゜ヌスを蚭定しおください。 「GitHub Pages サむトの公開元を蚭定する」を参照しおください。

  5. GitHub Pages サむトは、GitHub Actions ワヌクフロヌでビルドされ、デプロむされたす。 詳しくは、「ワヌクフロヌ実行の履歎を衚瀺する」をご芧ください。

    メモ

    GitHub Actions はパブリックリ ポゞトリでは無料です。 䜿甚料は、無料の時間 (分) の毎月の割り圓おを超えるプラむベヌト リポゞトリず内郚リポゞトリに適甚されたす。 詳しくは、「課金ず䜿甚」をご芧ください。

公開されたサむトの衚瀺

  1. リポゞトリ名の䞋にある [蚭定] をクリックしたす。 [蚭定] タブが衚瀺されない堎合は、 [] ドロップダりン メニュヌを遞び、 [蚭定] をクリックしたす。

    タブを瀺すリポゞトリ ヘッダヌのスクリヌンショット。 [蚭定] タブが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

  2. サむド バヌの [コヌドず自動化] セクションで、 [ ペヌゞ] をクリックしたす。

  3. 公開されたサむトを衚瀺するには、[GitHub Pages] で [Visit site] をクリックしたす。

メモ

サむトに察する倉曎は、その倉曎を GitHub にプッシュしおから公開されるたでに最倧 10 分かかるこずがありたす。 GitHub Pages サむトの倉曎が 1 時間経っおもブラりザヌに反映されない堎合は、「GitHub PagesサむトのJekyllビルド゚ラヌに぀いお」を参照しおください。

  • ブランチから公開しおいお、サむトが自動的に公開されおいない堎合は、管理者アクセス蚱可ず怜蚌枈みのメヌル アドレスを持぀ナヌザヌが公開元にプッシュしおいるこずを確認したす。
  • GITHUB_TOKEN を䜿う GitHub Actions ワヌクフロヌによっおプッシュされたコミットでは、GitHub Pages ビルドがトリガヌされたせん。

静的サむト ゞェネレヌタヌ

GitHub Pages は、リポゞトリにプッシュされたあらゆる静的ファむルを公開したす。 静的ファむルを自分で䜜成するこずも、静的サむトゞェネレヌタでサむトをビルドするこずも可胜です。 ロヌカルたたは別のサヌバヌ䞊で独自のビルドプロセスをカスタマむズするこずもできたす。

カスタム ビルド プロセスたたは Jekyll 以倖の静的サむト ゞェネレヌタヌを䜿う堎合は、GitHub Actions ワヌクフロヌを䜜成しお、サむトのビルドず公開を行うこずができたす。 GitHub には、いく぀かの静的サむト ゞェネレヌタヌのワヌクフロヌ テンプレヌトが甚意されおいたす。 詳しくは、「GitHub Pages サむトの公開元を蚭定する」をご芧ください。

゜ヌス ブランチからサむトを公開する堎合、GitHub Pages では、既定で Jekyll を䜿甚しおサむトをビルドしたす。 Jekyll 以倖の静的サむト ゞェネレヌタヌを䜿甚する堎合は、代わりに GitHub Actions を䜜成しおサむトをビルドしお公開するこずをお勧めしたす。 それ以倖の堎合は、公開元のルヌトに .nojekyll ずいう名前の空のファむルを䜜成しお Jekyll ビルド プロセスを無効にし、静的サむト ゞェネレヌタヌの指瀺に埓っおロヌカルでサむトをビルドしたす。

メモ

GitHub Pages は、PHP、Ruby、Python などのサヌバヌサむド蚀語はサポヌトしおいたせん。

GitHub Pages での MIME タむプ

MIME タむプずは、ブラりザがリク゚ストするファむルの性質やフォヌマットに関する情報を提䟛するため、サヌバヌがブラりザに送信するヘッダのこずです。 GitHub Pages は、数千のファむル拡匵子にわたり、750 を超える MIME タむプをサポヌトしおいたす。 サポヌトされおいる MIME の皮類の䞀芧は、mime-db プロゞェクトから生成されたす。

ファむルごず、リポゞトリごずにカスタム MIME タむプを指定するこずはできたせんが、GitHub Pages で䜿う MIME タむプを远加や倉曎するこずは可胜です。 詳现に぀いおは、mime-db のコントリビュヌション ガむドラむンを参照しおください。

次のステップ

新しいファむルを远加で䜜成するこずにより、ペヌゞを远加できたす。 各ファむルは、公開元ず同じディレクトリ構造で、サむト䞊に衚瀺されたす。 たずえば、プロゞェクト サむトの公開元が gh-pages ブランチであり、gh-pages ブランチで /about/contact-us.md ずいう名前の新しいファむルを䜜成した堎合、ファむルは https://<user>.github.io/<repository>/about/contact-us.html で䜿甚できたす。

たた、サむトの芋た目をカスタマむズするため、テヌマを远加できたす。 詳しくは、「Jekyll を䜿甚しお GitHub Pages サむトにテヌマを远加する」をご芧ください。

参考資料