Jekyll Workbox Plugin

Google Workbox integration for Jekyll

This plugin provides integration with Google Workbox for the Jekyll static site generator. It generates a service worker and provides precache integration with artifacts managed by Jekyll.

This plugin provides workbox-cli like functionality for projects using Jekyll. It's based on the Jekyll PWA Plugin, but it tries to be less clever than that, and focuses purely on the Workbox integration.

You see this plugin in action on my website, which is built using Jekyll and comes with a service worker for offline capabilities.

Installation

This plugin is available as a RubyGem.

Option #1

Add gem 'jekyll-workbox-plugin' to the jekyll_plugin group in your Gemfile:

source 'https://rubygems.org'

gem 'jekyll'

group :jekyll_plugins do
  gem 'jekyll-workbox-plugin'
end

Then run bundle to install the gem.

Option #2

Alternatively, you can also manually install the gem using the following command:

$ gem install jekyll-workbox-plugin

After the plugin has been installed successfully, add the following lines to your _config.yml in order to tell Jekyll to use the plugin:

plugins:
- jekyll-workbox-plugin

Getting Started

Configuration

Add the following configuration block to Jekyll's _config.yml:

workbox:
  sw_src_filepath: sw.js # Optional
  sw_dest_filename: sw.js # Optional
  precache_recent_posts_num: 5 # Optional
  precache_glob_directory: / # Optional
  precache_glob_patterns: # Optional
    - "{js,css,fonts}/**/*.{js,css,eot,svg,ttf,woff}"
    - index.html
    - "about.html": # This entry aliases about/ and contact/ to about.html
        - about/
        - contact/
  precache_glob_ignores: # Optional
    - "fonts/**/*"

Write your own Service Worker

Create a file sw.js in the root path of your Jekyll project. You can change this source file's path with sw_src_filepath option if you don't like the default.

Now you can write your own Service Worker with Workbox APIs, including a line workbox.precaching.precacheAndRoute([]);, which will be re-written by this plugin according to the precache configuration specified in the _config.yml file.

Here's what the sw.js like in my site.

// sw.js

// set names for both precache & runtime cache
workbox.core.setCacheNameDetails({
    prefix: 'benediktmeurer.de',
    suffix: 'v1',
    precache: 'precache',
    runtime: 'runtime-cache'
});

// let Service Worker take control of pages ASAP
workbox.skipWaiting();
workbox.clientsClaim();

// default to `networkFirst` strategy
workbox.routing.setDefaultHandler(workbox.strategies.networkFirst());

// let Workbox handle our precache list
// NOTE: This will be populated by jekyll-workbox-plugin.
workbox.precaching.precacheAndRoute([]);

// use `Stale-while-revalidate` strategy for images and fonts.
workbox.routing.registerRoute(
    /images/,
    workbox.strategies.staleWhileRevalidate()
);
workbox.routing.registerRoute(
    /^https?:\/\/fonts\.googleapis\.com/,
    workbox.strategies.staleWhileRevalidate()
);

Make sure to follow the Service Worker Checklist from the Workbox documentation. Insert this snippet in your JavaScript code somewhere:

if ('serviceWorker' in navigator) {
  window.addEventListener('load', function() {
      navigator.serviceWorker.register('/sw.js');
  });
}

i.e. put it inline near the closing </body> tag of every page:

<script>
  if ('serviceWorker' in navigator) {
    window.addEventListener('load', function() {
        navigator.serviceWorker.register('/sw.js');
    });
  }
</script>

...or into your JavaScript bundle. And also make sure to set the Cache-Control HTTP header to no-cache for the sw.js file. For example when using Netlify just put this snippet into your _headers file:

# _headers
/sw.js
  Cache-Control: no-cache

Or if you're using Firebase, put something like this into your firebase.json file:

{
  "hosting": {
    "headers": [
      {
        "source": "/sw.js",
        "headers": [{
          "key": "Cache-Control",
          "value": "no-cache"
        }]
      }
    ]
  }
}

Contribute

Just fork this repository, make changes and submit a pull request, or just file a bug report.

Copyright

Copyright (c) 2018 Benedikt Meurer.

Copyright (c) 2017 Pan Yuqi.

License: MIT