Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Jekyll version support #4

Open
MichaelCurrin opened this issue Nov 8, 2020 · 1 comment
Open

Update Jekyll version support #4

MichaelCurrin opened this issue Nov 8, 2020 · 1 comment

Comments

@MichaelCurrin
Copy link

I noticed that your Gemfile only supports Jekyll 4.

There are differences between 3 and 4, notably in the way the {% link file.md %} tag operates.

If you project is intended to only work on Jekyll 4 (ie it will break on Jekyll 3), then I recommend you add a note in the readme saying it only works on Jekyll 4 and therefore will not work on GitHub Pages (which only supports 3).

On the other hand, if you have no material differences in your code, I suggest you downgrade to Jekyll 3.9 in your Gemfile. This means that your project will work as a expected on GH Pages. your project will have a wider reach (I think most Jekyll users are using GH Pages and not some custom setup). And also there will no surprises between locally Jekyll 4 and GH Pages Jekyll 3.

Here is a list of all the gems that GitHub Pages is pinned to. Your Gemfile cannot alter what gets used on GH Pages, so it is safest to rather update your Gemfile to be in sync in GH.

https://pages.github.com/versions/

@MichaelCurrin
Copy link
Author

Sorry for the long message.

Here is my Gemfile in my template project for comparison.

https://github.com/MichaelCurrin/jekyll-blog-demo/blob/master/Gemfile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant