Cleanup

solectrus · Oct 8, 2024 · 4705a6d · 4705a6d
1 parent 6168d43
commit 4705a6d
Show file tree

Hide file tree

Showing 8 changed files with 104 additions and 225 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,21 +2,24 @@ name: CI
 
 on:
   push:
-    branches: ["main"]
+    branches: ['main']
   pull_request:
 
 jobs:
-  # Build job
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3' # Not needed with a .ruby-version file
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
           cache-version: 0 # Increment this number if you need to re-download cached gems
+
       - name: Build with Jekyll
         run: bundle exec jekyll build
+
+      - name: Check for broken links
+        run: bundle exec htmlproofer --log-level :debug ./_site
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -8,7 +8,7 @@ name: Deploy Jekyll site to Pages
 
 on:
   push:
-    branches: ["main"]
+    branches: ['main']
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -21,7 +21,7 @@ permissions:
 
 # Allow one concurrent deployment
 concurrency:
-  group: "pages"
+  group: 'pages'
   cancel-in-progress: true
 
 jobs:
@@ -31,20 +31,23 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3' # Not needed with a .ruby-version file
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
           cache-version: 0 # Increment this number if you need to re-download cached gems
+
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
+
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
         run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
+
       - name: Upload artifact
         # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v3
@@ -56,6 +59,7 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     needs: build
+
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/.ruby-version b/.ruby-version
@@ -0,0 +1 @@
+3.3.5
diff --git a/Gemfile b/Gemfile
@@ -1,7 +1,22 @@
 source 'https://rubygems.org'
 
-gem "jekyll", "~> 4.3.4" # installed by `gem jekyll`
-# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+# A simple, blog aware, static site generator. (https://jekyllrb.com)
+gem 'jekyll'
 
-gem "just-the-docs", "0.10.0" # pinned to the current release
-# gem "just-the-docs"        # always download the latest release
+# A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search. (https://github.com/just-the-docs/just-the-docs)
+gem 'just-the-docs'
+
+# Provides a simple logging utility for outputting messages. (https://github.com/ruby/logger)
+gem 'logger'
+
+# CSV Reading and Writing (https://github.com/ruby/csv)
+gem 'csv'
+
+# Class to build custom data structures, similar to a Hash. (https://github.com/ruby/ostruct)
+gem 'ostruct'
+
+# Support for encoding and decoding binary data using a Base64 representation. (https://github.com/ruby/base64)
+gem 'base64'
+
+# A set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your documentation output. (https://github.com/gjtorikian/html-proofer)
+gem 'html-proofer'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,27 +1,52 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    Ascii85 (1.1.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    afm (0.2.2)
+    async (2.17.0)
+      console (~> 1.26)
+      fiber-annotation
+      io-event (~> 1.6, >= 1.6.5)
+    base64 (0.2.0)
     bigdecimal (3.1.8)
     colorator (1.1.0)
     concurrent-ruby (1.3.4)
+    console (1.27.0)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
+    csv (3.3.0)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     eventmachine (1.2.7)
-    ffi (1.17.0-arm64-darwin)
-    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0)
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (1.0.0)
     forwardable-extended (2.6.0)
-    google-protobuf (4.28.1-arm64-darwin)
-      bigdecimal
-      rake (>= 13)
-    google-protobuf (4.28.1-x86_64-linux)
+    google-protobuf (4.28.2)
       bigdecimal
       rake (>= 13)
+    hashery (2.1.2)
+    html-proofer (5.0.9)
+      addressable (~> 2.3)
+      async (~> 2.1)
+      nokogiri (~> 1.13)
+      pdf-reader (~> 2.11)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+      zeitwerk (~> 2.5)
     http_parser.rb (0.8.0)
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
+    io-event (1.7.1)
     jekyll (4.3.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
@@ -46,6 +71,7 @@ GEM
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    json (2.7.2)
     just-the-docs (0.10.0)
       jekyll (>= 3.8.5)
       jekyll-include-cache
@@ -59,33 +85,57 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.1)
     mercenary (0.4.0)
+    mini_portile2 (2.8.7)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    ostruct (0.6.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
+    pdf-reader (2.12.0)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
     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)
-    rexml (3.3.7)
-    rouge (4.3.0)
+    rexml (3.3.8)
+    rouge (4.4.0)
+    ruby-rc4 (0.1.5)
     safe_yaml (1.0.5)
-    sass-embedded (1.78.0-arm64-darwin)
-      google-protobuf (~> 4.27)
-    sass-embedded (1.78.0-x86_64-linux-gnu)
+    sass-embedded (1.79.4)
       google-protobuf (~> 4.27)
+      rake (>= 13)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    ttfunk (1.8.0)
+      bigdecimal (~> 3.1)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
     unicode-display_width (2.6.0)
-    webrick (1.8.1)
+    webrick (1.8.2)
+    yell (2.2.2)
+    zeitwerk (2.6.18)
 
 PLATFORMS
-  arm64-darwin
-  x86_64-linux-gnu
+  ruby
 
 DEPENDENCIES
-  jekyll (~> 4.3.4)
-  just-the-docs (= 0.10.0)
+  base64
+  csv
+  html-proofer
+  jekyll
+  just-the-docs
+  logger
+  ostruct
 
 BUNDLED WITH
-   2.5.9
+   2.5.21
diff --git a/LICENSE b/LICENSE