Skip to content

Jekyll Plugins

On this page:

Loading...

Use community-contributed packages and run custom code to extend your sites. All Jekyll sites on CloudCannon support Jekyll plugins.

Add plugins to a site in a couple of ways:

  • Add .rb files to the _plugins folder
  • Add plugins to your Gemfile in the root folder

Here’s an example Gemfile:

Gemfile
source 'https://rubygems.org'

gem 'jekyll', '3.1.6'

group :jekyll_plugins do
  gem 'jekyll-sitemap', '0.10.0'
end
Note

It’s good practice to set your versions. Otherwise, Jekyll uses the latest version which could introduce breaking changes in future builds.

Caching bundle installs

Installing your gems can take quite some time.

To save time on consecutive builds CloudCannon does the following:

  1. Installs your gems to a local folder
  2. Caches that folder based on your Gemfile.lock
  3. When no local gems are found, build your site using the cached installs from your previous builds

To disable this feature, go to Site Settings / Configuration.

Note

Older Jekyll sites on CloudCannon will have this caching disabled to prevent changes to their build environment. Enabling this can greatly improve editing experience.

On this page:

Loading...

Don’t miss the latest
CloudCannon news freshly delivered to your inbox