From 464d4b0254833d296f45bf9cd1ec50b843e2271e Mon Sep 17 00:00:00 2001 From: Anton Date: Thu, 8 Oct 2015 09:59:15 +0300 Subject: [PATCH 1/4] update plugins documentation you have to install gem files for plugins for them in order to work --- site/_docs/plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index 440623bf..4b14ec1b 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -29,7 +29,7 @@ You have 3 options for installing plugins: here. Any file ending in `*.rb` inside this directory will be loaded before Jekyll generates your site. 2. In your `_config.yml` file, add a new array with the key `gems` and the -values of the gem names of the plugins you'd like to use. An example: +values of the gem names of the plugins you'd like to use. Don't foreget to install your plugins using `gem install my-jekyll-plugin` prior running jekyll. An example: gems: [jekyll-test-plugin, jekyll-jsonify, jekyll-assets] # This will require each of these gems automatically. From 3435d05c2a4e41a44784e27058460be86a16134d Mon Sep 17 00:00:00 2001 From: Anton Date: Thu, 8 Oct 2015 10:23:29 +0300 Subject: [PATCH 2/4] Update plugins.md Note to option 2 and 3 for installing plugins --- site/_docs/plugins.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index 4b14ec1b..75832afd 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -29,7 +29,7 @@ You have 3 options for installing plugins: here. Any file ending in `*.rb` inside this directory will be loaded before Jekyll generates your site. 2. In your `_config.yml` file, add a new array with the key `gems` and the -values of the gem names of the plugins you'd like to use. Don't foreget to install your plugins using `gem install my-jekyll-plugin` prior running jekyll. An example: +values of the gem names of the plugins you'd like to use. An example: gems: [jekyll-test-plugin, jekyll-jsonify, jekyll-assets] # This will require each of these gems automatically. @@ -40,6 +40,8 @@ values of the gem names of the plugins you'd like to use. Don't foreget to insta gem "my-jekyll-plugin" end +Both option 2 and 3 require you to install your plugins using `gem install my-jekyll-plugin` prior running jekyll. +
_plugins, _config.yml and Gemfile From bc3e67da62bd23b45d4e45f42c1e42eb61bd5296 Mon Sep 17 00:00:00 2001 From: Anton Date: Thu, 8 Oct 2015 21:47:29 +0300 Subject: [PATCH 3/4] Update plugins.md Added gem install and bundle install commands for plugins set up --- site/_docs/plugins.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index 75832afd..fb29967b 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -28,19 +28,26 @@ You have 3 options for installing plugins: 1. In your site source root, make a `_plugins` directory. Place your plugins here. Any file ending in `*.rb` inside this directory will be loaded before Jekyll generates your site. -2. In your `_config.yml` file, add a new array with the key `gems` and the +2. * In your `_config.yml` file, add a new array with the key `gems` and the values of the gem names of the plugins you'd like to use. An example: + ```rb gems: [jekyll-test-plugin, jekyll-jsonify, jekyll-assets] # This will require each of these gems automatically. -3. Add the relevant plugins to a Bundler group in your `Gemfile`. An + ``` + + * Install your plugins using `gem install jekyll-test-plugin` +3. * Add the relevant plugins to a Bundler group in your `Gemfile`. An example: + ```rb group :jekyll_plugins do gem "my-jekyll-plugin" end + ``` + + * Run `bundle install` -Both option 2 and 3 require you to install your plugins using `gem install my-jekyll-plugin` prior running jekyll.
From 6cda306bbf8d332dfdd46167eaf66e9bdc868fcf Mon Sep 17 00:00:00 2001 From: Anton Date: Fri, 9 Oct 2015 10:23:08 +0300 Subject: [PATCH 4/4] Update plugins.md Corrected display of installing options --- site/_docs/plugins.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index fb29967b..584bc6cd 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -28,25 +28,24 @@ You have 3 options for installing plugins: 1. In your site source root, make a `_plugins` directory. Place your plugins here. Any file ending in `*.rb` inside this directory will be loaded before Jekyll generates your site. -2. * In your `_config.yml` file, add a new array with the key `gems` and the +2. In your `_config.yml` file, add a new array with the key `gems` and the values of the gem names of the plugins you'd like to use. An example: - ```rb + gems: [jekyll-test-plugin, jekyll-jsonify, jekyll-assets] # This will require each of these gems automatically. - ``` - - * Install your plugins using `gem install jekyll-test-plugin` -3. * Add the relevant plugins to a Bundler group in your `Gemfile`. An + + Then install your plugins using `gem install jekyll-test-plugin jekyll-jsonify jekyll-assets` + +3. Add the relevant plugins to a Bundler group in your `Gemfile`. An example: - ```rb group :jekyll_plugins do gem "my-jekyll-plugin" + gem "another-jekyll-plugin" end - ``` - - * Run `bundle install` + + Now you need to install all plugins from your Bundler group by running single command `bundle install`