feat: use Workbox to enable offline content

Author: jonahsnider

mkdocs.yml

@@ -56,6 +56,7 @@ plugins:
   # - git-revision-date-localized
   - minify:
       minify_html: true
+      minify_js: true
 
 # Google Analytics
 google_analytics:

overrides/main.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+
+{% block libs %}
+  <!-- From https://developers.google.com/web/tools/workbox/guides/get-started#create_and_register_a_service_worker_file -->
+  <script>
+    // Check that service workers are supported
+    if ("serviceWorker" in navigator) {
+      // Use the window load event to keep the page load performant
+      window.addEventListener("load", () =>
+        navigator.serviceWorker.register("/sw.js")
+      );
+    }
+  </script>
+{% endblock %}

package.json

@@ -1,9 +1,11 @@
 {
   "name": "docs",
   "devDependencies": {
-    "prettier": "2.0.5"
+    "prettier": "2.0.5",
+    "workbox-cli": "^5.1.3"
   },
   "scripts": {
-    "style": "prettier --check ."
+    "style": "prettier --check .",
+    "sw:gen": "workbox generateSW workbox-config.js"
   }
 }

workbox-config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  "globDirectory": "site/",
+  "globPatterns": [
+    "**/*.{html,png,js,css,Identifier,txt,webmanifest,json,xml,gz}"
+  ],
+  "swDest": "site/sw.js"
+};