What's new in Jekyll 3.8
This was originally a guest post written for the Forestry.io blog
Jekyll 3.8.1 was released on the 1st of May 2018, just two weeks after 3.8.0. The project has come a long way since I last wrote a Jekyll update. Olivia is now Jekyll’s new Lead Developer since Parker Moore decided to step down after four years leading the project.
So what does Jekyll bring us this time?
Performance optimizations #
Large sites containing a huge amount of posts are going to see a massive reduction in their total build times especially if they are doing multiple calls to the where filter with the same input and property parameter.
On i18n websites, some users have reported an amazing significant decrease in their build time with Jekyll 3.8.
Jekyll also now calculates site.related_posts only when needed and way more efficiently. It’s only noticeable if you have thousands of posts.
Let’s test this with a blog with more than 2200 posts and some default plugins.
https://idratherbewriting.com/ took on average around 140s to build with Jekyll 3.7.3.
Now it takes around 112s with 3.8.0. That’s a 20% decrease!
Your mileage may vary depending on your layouts, the plugins used, and the size of your website.
My minimal and tiny blog now builds in 1.76 seconds which is merely 0.02 seconds faster on average. Don’t expect a major speed improvement for such a small website.
Ordinal dates support #
My favorite new feature has to be that Jekyll now allows date filters to output ordinal dates.
As you may know to display dates in Jekyll we need to use the {{ page.date }} liquid tag. This outputs the date like so;
2018-04-22 22:52:12 +0100
To produce a date more reader friendly i’d normally add a date filter like {{ page.date | date: "%-d %B, %Y" }} which outputs;
April 22, 2018
Most people would call it a day here but Jekyll 3.8 now makes it super easy to add ordinal date. You no longer need to bloat your post layout template with liquid or depending on a plugin to do the heavy lifting.
US ordinal dates #
{{ page.date | date_to_long_string: "ordinal", "US" }} will output April 24th, 2018.
{{ page.date | date_to_string: "ordinal", "US" }} will output Apr 24th, 2018.
UK ordinal dates #
{{ page.date | date_to_long_string: "ordinal" }} will output 24th April 2018.
{{ page.date | date_to_string: "ordinal" }} will output 24th Apr 2018.
Detection of non-existent variables and filters #
Jekyll can now detect non-existent variables and filters specified in a template.
To set this up add the following to your sites config.yml file.
liquid:
error_mode: warn
strict_filters: true
strict_variables: true
Liquid’s response to errors has three settings which can be configured by setting error_mode to lax , warn or strict.
lax — Ignore all errors.
warn — Output a warning on the console for each error.
strict — Output an error message and stop the build.
After restarting my own site I ran into the following error.
Liquid Exception: Liquid error (line 5): undefined variable subtitle in /_layouts/post.html
jekyll 3.8.0 | Error: Liquid error (line 5): undefined variable subtitle
It turns out I have a {{ page.subtitle }} variable in my post.html layout template which is not currently being used site-wide on build. I may consider removing this variable sometime in the future to optimize my site build times further. This new feature will be extremely useful to help remove code bloat when working with larger more complicated websites.
Documentation Updates #
Ruby installation is certainly the most frustrating part and biggest pain point for beginners.
It’s now much easier to get started installing Jekyll on macOS Ubuntu or Windows using the official instructions. I have previously written about my own experience installing Jekyll on my Macbook.
You may also want to read over this new tutorial to help you use bundler to handle your Ruby gems in your Jekyll’s projects. Alternatively you may be interested in Forestry’s create static site, a tool that can set up a new Hugo or Jekyll site with a modern, production-ready build pipeline in seconds.
If you are looking to add search to your static site, give jekyll-algolia plugin a try. Algolia have provided great documentation which includes a live demo to get you up and running quickly with Algolia search for Jekyll.
Search has been successfully implemented on http://yeoman.io/generators/ and https://idratherbewriting.com/ if you want to give it a try.
Chris Macrae has also previously covered Jekyll Search with Algolia and Webtasks on the Forestry blog. I highly recommend you check it out.
Premonition is a Jekyll plugin by Jakob Vad Nielsen that can transform Markdown blockquotes into styled blocks of code. This plugin makes adding notices to your Jekyll site a breeze. Check out the demo site.
What’s next? #
Development of Jekyll 4.0 has started, so now is the right time to share your ideas for the next major version. We should see some improvements on the incremental regeneration, smarter URL filters and hopefully a more coherent way to manage posts, pages and collection’s documents.
An official directory to allow to search for plugins and open source gem-based themes is also in the work.
If you would like to get involved with the project check out Jekyll’s contributor and maintaining docs for ways to contribute.
Please share if you found this post helpful and let me know if you’d like to see more of these updates.
Until next time. Jekyll FTW