chore: Documentation update

docs/.gitignore

@@ -1,4 +1,5 @@
 _site
 .sass-cache
 .jekyll-metadata
-vendor
+vendor
+.bundle

docs/Gemfile

@@ -26,4 +26,4 @@ gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 # Performance-booster for watching directories on Windows
 gem "wdm", "~> 0.1.0" if Gem.win_platform?
 
-gem "just-the-docs", "0.3.1"
+gem "just-the-docs", "0.3.3"

docs/Gemfile.lock

@@ -192,7 +192,7 @@ GEM
  gemoji (~> 3.0)
  html-pipeline (~> 2.2)
  jekyll (>= 3.0, < 5.0)
- just-the-docs (0.3.1)
+ just-the-docs (0.3.3)
  jekyll (>= 3.8.5)
  jekyll-seo-tag (~> 2.0)
  rake (>= 12.3.1, < 13.1.0)
@@ -220,7 +220,7 @@ GEM
  pathutil (0.16.2)
  forwardable-extended (~> 2.6)
  public_suffix (3.1.1)
- rake (13.0.1)
+ rake (13.0.3)
  rb-fsevent (0.10.4)
  rb-inotify (0.10.1)
  ffi (~> 1.0)
@@ -260,7 +260,7 @@ DEPENDENCIES
  github-pages
  jekyll-feed (~> 0.6)
  jemoji
- just-the-docs (= 0.3.1)
+ just-the-docs (= 0.3.3)
  tzinfo-data
 
 BUNDLED WITH

docs/docker-compose.yml

@@ -0,0 +1,15 @@
+# --------------------------------------------------
+# docker-compose.yml to enable documentation live reload using docker
+# see https://svrooij.io/2020/12/31/github-pages-live-reload/
+# --------------------------------------------------
+version: '3.3'
+services:
+ jekyll:
+ volumes:
+ - './.bundle:/usr/local/bundle'
+ - './:/srv/jekyll'
+ ports:
+ - '4000:4000'
+ - '35729:35729'
+ image: jekyll/jekyll
+ command: jekyll serve --livereload --force_polling --incremental

package.json

@@ -17,7 +17,7 @@
  "preferGlobal": true,
  "scripts": {
  "build": "tsc",
- "serve-docs": "docker run --rm --volume=\"$PWD/docs/vendor/bundle:/usr/local/bundle\" --volume=\"$PWD/docs:/srv/jekyll\" -p 4000:4000 -p 35729:35729 -it jekyll/jekyll jekyll serve --livereload",
+ "serve-docs": "docker-compose -f ./docs/docker-compose.yml up jekyll",
  "test": "eslint ./src/*.ts"
  },
  "dependencies": {