GitHub Pagesのクイックスタート

GitHub Pagesを使って、オープンソースプロジェクトを紹介したり、ブログをホストしたり、履歴書を共有することさえもできます。 このガイドは、次のWebサイトを作成し始めるための役に立ちます。

この機能を使用できるユーザーについて

GitHub Pagesは、パブリック・リポジトリのGitHub Freeと組織用のGitHub Free、パブリック・リポジトリとプライベート・リポジトリのGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。 詳しくは、「GitHub のプラン」をご覧ください。

GitHub Pages で、Jekyll ビルドの実行に GitHub Actions が使用されるようになりました。 ビルドのソースとしてブランチを使用する際、組み込みの Jekyll ワークフローを使用する場合は、リポジトリで GitHub Actions を有効にする必要があります。 GitHub Actions が使用できない場合、または無効になっている場合は、ソース ブランチのルートに .nojekyll ファイルを追加すると、Jekyll ビルド プロセスがバイパスされ、コンテンツが直接デプロイされます。 GitHub Actions の有効化の詳細については、「リポジトリの GitHub Actions の設定を管理する」を参照してください。

この記事の内容

はじめに

GitHub Pagesは、GitHubを通じてホストされ、公開されるパブリックなWebページです。 立ち上げて実行するための最速の方法は、Jekyll テーマ選択画面を使って事前作成されたテーマをロードすることです。 その後、GitHub Pagesのコンテンツやスタイルを変更できます。

このガイドでは、username.github.io でのユーザー サイトの作成手順について説明します。

Webサイトの作成

  1. ページの右上隅で を選択し、 [新しいリポジトリ] をクリックします。

    新しいアイテムを作成するオプションを示す GitHub ドロップダウン メニューのスクリーンショット。 [新しいリポジトリ] というメニュー項目が濃いオレンジ色の枠線で囲まれています。

  2. リポジトリ名として username.github.io を入力します。 username を GitHub のユーザー名に置き換えます。 たとえば、ユーザー名が octocat の場合、リポジトリ名を octocat.github.io とする必要があります。

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

  3. リポジトリの可視性を選択してください。 詳しくは、「リポジトリについて」を参照してください。

  4. [Initialize this repository with a README] (このレポジトリを README で初期化する) を選択します。

  5. [Create repository] (リポジトリの作成) をクリックします。

  6. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  7. サイド バーの [コードと自動化] セクションで、 [ ページ] をクリックします。

  8. [ビルドとデプロイ] の [ソース] で、 [ソースからのデプロイ] を選択します。

  9. [ビルドとデプロイ] の [ブランチ] で、[ブランチ] ドロップダウン メニューを使って、公開元を選びます。

    GitHub リポジトリの Pages 設定のスクリーンショット。 [なし] というラベルの付いた公開元のブランチを選ぶメニューが、濃いオレンジ色の枠線で囲まれています。

  10. 必要に応じて、リポジトリの README.md ファイルを開きます。 README.md ファイルは、サイトのコンテンツを記述する場所です。 このファイルを編集することも、あるいはとりあえずデフォルトの内容をそのままにしておくこともできます。

  11. username.github.io にアクセスして新しい Web サイトをご覧ください。 サイトに対する変更は、その変更を GitHub にプッシュしてから公開されるまで、最大 10 分かかることがあることにご留意ください。

タイトルと説明の変更

既定では、サイトのタイトルは username.github.io になります。 リポジトリ内の _config.yml ファイルを編集することで、タイトルを変更できます。 サイトの説明を追加することもできます。

  1. リポジトリの Code タブをクリックします。

  2. ファイルの一覧で、_config.yml をクリックしてファイルを開きます。

  3. をクリックしてファイルを編集してください。

  4. _config.yml ファイルには、サイトのテーマを指定する行が既に含まれています。 新しい行を追加し、title: に続けて必要なタイトルを記載します。 新しい行を追加し、description: に続けて必要な説明を記載します。 次に例を示します。

    theme: jekyll-theme-minimal
title: Octocat's homepage
description: Bookmark this to keep an eye on my project updates!

  5. ファイルの編集が完了したら、 Commit changes をクリックします。

次の手順

サイトにページを追加する方法の詳細については、「Jekyll を使用して GitHub Pages サイトにコンテンツを追加する」を参照してください。

Jekyll で GitHub Pages サイトを設定する方法の詳細については、「GitHub PagesとJekyllについて」を参照してください。