GitHub Pages サイトへの Jekyll テーマの追加

GitHub Pages は、GitHub Enterprise でホストされているオープンソースの Jekyll テーマとともに、公式にサポートされている Jekyll テーマをサポートしています。 詳しい情報についてはGitHub 上の Jekyll テーマについてを参照してください。

Jekyll テーマのデフォルトは、サイトの以下のフォルダー内のコンテンツで上書きできます:

• _layouts
• _includes
• _sass
• アセット

オーバーライドできる Jekyll テーマのファイルに関する詳しい情報については、使用するテーマの README または使用するテーマのソースリポジトリのその他のドキュメンテーションを参照してください。

サイトの _config.yml ファイル内への Jekyll テーマの追加

1. GitHub Enterprise で、リポジトリのメインページへ移動します。

2. リポジトリ中の _config.yml にアクセスしてください。

3. ファイルビューの右上の隅で、 をクリックしてファイルエディターを開きます。

   

4. _config.yml にテーマ名で新しい行を追加して、テーマをアクティベートしてください。

   • 公式にサポートされているテーマのいずれかをアクティベートするには、theme: に続けてそのテーマ名を入力してください (テーマのソースリポジトリの README にあるように)。
     
   • GitHub Enterprise でホストされているオープンソースの Jekyll テーマのいずれかをアクティベートするには、remote_theme: に続けてそのテーマの名前を入力します (そのテーマのソースリポジトリの README その他のドキュメンテーションに記されています)。
     

5. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。

   

6. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが master なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。

   

7. [Propose file change] をクリックします。

   

8. プルリクエストを作成した場合は、GitHub Pagesの公開ブランチにプルリクエストをマージしてください。このブランチは、通常は master ですが、gh-pages のこともあります。

これで、追加した新しいテーマを使ってサイトが公開されます。

ローカルで Jekyll テーマをプレビュー

Jekyll テーマを 使用している GitHub Enterprise Serverインスタンスのサイトの _config.yml ファイルに追加した場合、以下のセクションで詳しく説明されている手順に従って、そのテーマをローカルでプレビューできます。

Jekyll テーマをローカルでプレビューしようとする前に、以下を確認してください:

• 使っているコンピュータ上に、リモート GitHub Pages サイトリポジトリのローカルコピーがあること。 サイトのリポジトリのローカルコピーがない場合はリポジトリのクローンを参照してください。リモートの GitHub Pagesサイトリポジトリがまだ 使用している GitHub Enterprise Serverインスタンス上にない場合、誰か他の人のオープンソースサイトリポジトリを出発点のテンプレートとし、フォークして使用することができます。
• Bundler がインストールされていること。

Gemfile にテーマを Gem として追加する

1. GitHub Enterprise で、リポジトリのメインページへ移動します。

2. リポジトリ中で Gemfile にアクセスしてください。

3. ファイルビューの右上隅で をクリックしてファイルエディターを開いてください。

4. Gemfileで、テーマ名を引用符で囲って、新しい行として追加します:

   

   参考: Gemfile には複数の Jekyll テーマを追加できますが、それらをアクティベートするために _config.yml に追加できるテーマは 1 つだけです。

5. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。

   

6. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが master なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。

   

7. [Propose file change] をクリックします。

   

8. プルリクエストを作成した場合は、GitHub Pagesの公開ブランチにプルリクエストをマージしてください。このブランチは、通常は master ですが、gh-pages のこともあります。 サイトを公開するためのブランチの選択に関する詳しい情報についてはユーザ、Organization、プロジェクトPagesを参照してください。

Bundler を使ったテーマのインストール

1. ターミナルターミナルGit Bashターミナル を開いてください。

2. ローカルの GitHub Pages サイトリポジトリにアクセスしてください。

   $ cd my-pages-site-repository

3. 使用している GitHub Enterprise Serverインスタンス 上のリモートのサイトリポジトリから変更をローカルのサイトリポジトリにロードしてください。

   $ git pull

   Tip: For more information on using git pull, see "Getting changes from a remote repository."

4. Bundler を使って Jekyll テーマの Gem をインストールしてください。

   $ bundle install
   > Fetching gem metadata from https://rubygems.org/............
   Fetching version metadata from https://rubygems.org/...
   Fetching dependency metadata from https://rubygems.org/..
   Resolving dependencies...
   . . .
   Installing minima 1.0.1
   Using bundler 1.10.6
   Bundle complete! 2 Gemfile dependencies, 54 gems now installed.
   Use `bundle show [gemname]` to see where a bundled gem is installed.

5. Push your changes up to your remote GitHub Pages site repository on 使用している GitHub Enterprise Serverインスタンス, replacing master in the example below with gh-pages if you use a gh-pages branch to publish your site:

   $ git push origin master

コマンドライン上で Jekyll テーマを追加する

1. ターミナルターミナルGit Bashターミナル を開いてください。

2. ローカルのサイトリポジトリに移動します:

   $ cd my-pages-site-repository

3. To add a theme to your site's Gemfile, open your favorite text editor, such as Atom, and add this line to your Gemfile using your selected theme's name in quotations:

   gem "minima"
   # Minima is a default theme for Jekyll sites.

   参考: Gemfile には複数の Jekyll テーマを追加できますが、それらの中でテーマとしてアクティベートするために _config.yml に追加できるのは 1 つだけです。

4. Bundler を使って Jekyll テーマの Gem をインストールしてください。

   $ bundle install
   > Fetching gem metadata from https://rubygems.org/............
   Fetching version metadata from https://rubygems.org/...
   Fetching dependency metadata from https://rubygems.org/..
   Resolving dependencies...
   . . .
   Installing minima 1.0.1
   Using bundler 1.10.6
   Bundle complete! 2 Gemfile dependencies, 54 gems now installed.
   Use `bundle show [gemname]` to see where a bundled gem is installed.

5. テーマをアクティベートするには、好きなテキストエディタを使ってサイトの _config.yml ファイルにテーマの名前を新しい行として追加してください:

   theme: minima

6. Git を使って変更を追加し、コミットします:

   $ git commit -a
   # Adds your changes
   $ git commit -m "added theme to Gemfile & _config.yml"
   # Commits your changes with a commit message

7. Push your changes up to your remote GitHub Pages site repository, replacing master in the example below with gh-pages if you use a gh-pages branch to publish your site::

   $ git push origin master

これで、追加した新しいテーマを使ってサイトが公開されます。

参考リンク

• テーマに関するJekyllの公式ドキュメンテーション

• GitHub 上の Jekyll テーマについて

• Jekyll テーマの CSS および HTML のカスタマイズ