GitHub PagesでJekyll Remote Themeを使ってみる

less than 1 minute read

前段

Jekyllはv3.2からThemeをGem経由で使用できる機能を導入しました。

GitHub Pages(github/pages-gem)ではv107からこの機能が使用できるようになりました。 しかし、使用できるGemベースThemeはホワイトリストで指定されたものであり、限られたものでした。

# v107の時点で使用できたGemベースTheme
    THEMES = {
      "minima"                    => "2.0.0",
      "jekyll-swiss"              => "0.4.0",
      "jekyll-theme-primer"       => "0.1.1"
    }.freeze

2017/11/06にリリースされたgithub/pages-gemのv168から、Jekyll Remote Theme(benbalter/jekyll-remote-theme)が使用可能になったため、基本的にはどのようなGemベースThemeでもGitHub Pagesで使用できるようになりました。

導入方法

Gemfilejekyll-remote-themeを追加し、$ bundle installします。

gem "github-pages", group: :jekyll_plugins
gem "jekyll-remote-theme"

jekyll-remote-theme_config.ymlpluginsに追加します。

# Plugins
plugins:
  - jekyll-remote-theme

また同じく_config.ymlremote_themeを追加します。

# 使用したいGemベースThemeを指定
# GitHubのリポジトリ上にあるものしか指定できないので注意
remote_theme: "#{theme.owner}/#{theme.name}"

以上の設定を行い、$ bundle exec jekyll serverを行いましょう。 下記のような出力が出ればjekyll-remote-themeが正常に設定できています。

......
 Incremental build: disabled. Enable with --incremental
      Generating...
      Remote Theme: Using theme #{theme.owner}/#{theme.name}
......

Happy Jekylling!

Tags:

Updated: