プラグイン

プラグインのインストールに3つのオプションがあります。

  1. サイトのソースrootに_pluginsディレクトリを作ります。プラグインをここに入れます。このディレクトリにある*.rbで終わる全てのファイルはJekyllがサイトを生成する前に読み込まれます。
  2. _config.ymlファイルにpluginsキー(もしくはJekyll < 3.5.0gems)と使用したいgem名の値の配列を追加します。例えば、

    # This will require each of these plugins automatically.
    plugins:
      - jekyll-gist
      - jekyll-coffeescript
      - jekyll-assets
      - another-jekyll-plugin
    

    次にgem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-pluginでプラグインをインストールします。

  3. GemfileのBundlerグループに関連するプラグインを追加します。例えば、
    group :jekyll_plugins do
      gem "jekyll-gist"
      gem "jekyll-coffeescript"
      gem "jekyll-assets"
      gem "another-jekyll-plugin"
    end

bundle installコマンドを実行して、Bundlerグループから全てのプラグインをインストールする必要があります。

GitHub Pagesでのプラグイン

GitHub PagesはJekyllで動いています。セキュリティ上の理由で(いくつかのホワイトリストのプラグインを除く)プラグインを無効にする--safeオプションで全てのページを生成します。GitHub Pagesで公開する場合はあなたのプラグインが機能しないことを意味します。

GitHubページを使用してサイトを公開することはできますが、サイトをローカルで変換し、Jekyllのソースファイルではなく、生成された静的ファイルをGitHubリポジトリにプッシュする必要があります。

_plugins_config.ymlGemfileは同時に使用できます。

同じサイト内で上記のプラグインオプションを同時に使用することもできます。1つの使用は他の使用を制限しません。

jekyll_pligin グループ

JekyllはGemfileの中の特定のGemグループを別に扱います。このグループに含まれる全てのGemは、Jekyllがあなたのソースディレクトリの残りを処理し始める前にロードされます。

ここに含まれるGemは、設定ファイルのplugins:キーに明示されなくても、有効になります。

:jekyll-pluginsグループに含まれるGemは、--safeモード設定に関係なく有効になります。このグループにどのようなGemが含まれているかに、注意してください!