ci: do not use pre-made jekyll action

Author: noraj

.github/workflows/documentation.yml

@@ -19,15 +19,14 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-      - name: Build YARD documentation
-        id: build
+      - name: Build Jekyll documentation
+        id: build-jekyll
+        run: bundle exec jekyll build
+      - name: Build YARD documentation # must be after jekyll as jekyll wipe the destination folder before building
+        id: build-yard
         run: bundle exec yard doc
       - name: Setup Pages
         uses: actions/configure-pages@v5
-      - name: Build Jekyll documentation
-        uses: actions/jekyll-build-pages@v1 # https://github.com/actions/jekyll-build-pages
-        with:
-          destination: output/
       - name: Upload static files as artifact
         id: deployment
         uses: actions/upload-pages-artifact@v3 # https://github.com/actions/upload-pages-artifact
@@ -38,7 +37,7 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
-    needs: build
+    needs: build-yard, build-jekyll
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

Gemfile

@@ -37,7 +37,11 @@ group :development, :docs do
   # gem 'commonmarker', '~> 2.0' # for markdown support in YARD
 
   gem 'commonmarker', '~> 0.23' # for markdown support in YARD
+  gem 'jekyll', '~> 4.4', '>= 4.4.1' # user documentation
+  gem 'jekyll-commonmark', '~> 1.4' # jekyll markdown plugin
+  gem 'jekyll-remote-theme', '~> 0.4.3' # jekyll theme plugin
+  gem 'jekyll-seo-tag', '~> 2.8' # jekyll seo plugin
   gem 'webrick', '~> 1.9' # for yard server
-  gem 'yard', ['>= 0.9.37', '< 0.10']
+  gem 'yard', ['>= 0.9.37', '< 0.10'] # library documentation
   gem 'yard-coderay', '~> 0.1' # for syntax highlight support in YARD
 end

Gemfile.lock

@@ -1,23 +1,95 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
+    colorator (1.1.0)
     commonmarker (0.23.11)
+    concurrent-ruby (1.3.5)
+    csv (3.3.2)
     docopt (0.6.1)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.17.1)
+    ffi (1.17.1-x86_64-linux-gnu)
+    forwardable-extended (2.6.0)
+    google-protobuf (4.29.3)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.29.3-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
+    http_parser.rb (0.8.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.4.1)
+      addressable (~> 2.4)
+      base64 (~> 0.2)
+      colorator (~> 1.0)
+      csv (~> 3.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      json (~> 2.6)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.3, >= 0.3.6)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-commonmark (1.4.0)
+      commonmarker (~> 0.22)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
     json (2.11.3)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
+    liquid (4.0.4)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
     minitest (5.25.5)
     parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
     prism (1.4.0)
+    public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
     regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rouge (4.5.1)
     rubocop (1.75.4)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -33,9 +105,16 @@ GEM
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    rubyzip (2.4.1)
+    safe_yaml (1.0.5)
+    sass-embedded (1.83.4)
+      google-protobuf (~> 4.29)
+      rake (>= 13)
+    sass-embedded (1.83.4-x86_64-linux-gnu)
+      google-protobuf (~> 4.29)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.6.0)
     webrick (1.9.1)
     yard (0.9.37)
     yard-coderay (0.1.0)
@@ -50,6 +129,10 @@ DEPENDENCIES
   bundler (~> 2.1)
   commonmarker (~> 0.23)
   docopt (~> 0.6)
+  jekyll (~> 4.4, >= 4.4.1)
+  jekyll-commonmark (~> 1.4)
+  jekyll-remote-theme (~> 0.4.3)
+  jekyll-seo-tag (~> 2.8)
   minitest (~> 5.25)
   rake (~> 13.2)
   rubocop (~> 1.75)