Fix: Add note about using plugins instead of gems key #197
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
localheinz
force-pushed
the
fix/config
branch
from
3a54519
to
2158efa
Compare
localheinz
changed the title
DirtyF
approved these changes
Nov 3, 2017
|
While we should encourage the use of this config key, but at the same time we must not forget those using older versions of Jekyll. This works only for Jekyll > 3.5.0, and will display a possibly confusing error message as |
|
Good point! Would you prefer me to close this PR, or adjust the instructions so they reflect the proper usage on older and new versions of Jekyll? |
|
@localheinz Please do upgrade the instructions ✍️ |
localheinz
force-pushed
the
fix/config
branch
from
2158efa
to
a37b17c
Compare
localheinz
changed the title
localheinz
force-pushed
the
fix/config
branch
2 times, most recently
from
c4ccbc4
to
b04c65f
Compare
|
👍 |
DirtyF
reviewed
Nov 4, 2017
README.md
Outdated
| @@ -19,6 +19,8 @@ gems: | |||
| - jekyll-feed | |||
| ``` | |||
|
|
|||
| :bulb: If you are using Jekyll `^3.5.0`, you probably want to use the `plugins` key instead of `gems`. | |||
There was a problem hiding this comment.
I'm not sure everybody understands this notation. What about plain text?
💡 If you are using Jekyll version 3.5.0 or greater, use the pluginskey instead of gems.
localheinz
force-pushed
the
fix/config
branch
from
b04c65f
to
2edb8c3
Compare
|
@jekyllbot: merge +docs |
|
Thank you, @DirtyF! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR
README.mdwith a note about using thepluginsinstead of thegemskey for enabling the plugin💁♂️ For reference, see jekyll/jekyll#5130.