docs: 🕸️ Add a website

.github/workflows/build.yaml

@@ -53,6 +53,62 @@ jobs:
         path: build/build-*.zip
         if-no-files-found: error
 
+  website-build:
+
+    needs: build
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        lfs: true
+
+    - name: Checkout required submodules
+      run: |
+        git submodule update --init --depth 1 scripts/build-tools
+        git submodule update --init --depth 1 scripts/changes
+        git submodule update --init --depth 1 docs/_theme
+
+    - name: Install the tool dependencies
+      uses: jdx/mise-action@v4
+
+    - name: Install dependencies
+      run: scripts/install-dependencies.sh
+
+    - name: Build website
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        scripts/build-website.sh
+        chmod -v -R +rX "_site/"
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v5
+
+  website-deploy:
+
+    needs: website-build
+    if: ${{ github.ref == 'refs/heads/main' }}
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5
+
   sparkle-update:
     needs: build
     if: ${{ needs.build.outputs.released == 'true' }}

.gitignore

@@ -0,0 +1,12 @@
+**.xcuserdatad
+.DS_Store
+.env
+.nova
+/.local
+/_site
+/docs/.jekyll-cache
+/docs/_site
+/docs/releases
+build
+temp
+xcuserdata/

.gitmodules

@@ -6,10 +6,13 @@
 	url = git@github.com:inseven/interact.git
 [submodule "scripts/changes"]
 	path = scripts/changes
-	url = git@github.com:jbmorley/changes.git
+	url = https://github.com/jbmorley/changes.git
 [submodule "scripts/build-tools"]
 	path = scripts/build-tools
-	url = git@github.com:jbmorley/build-tools.git
+	url = https://github.com/jbmorley/build-tools.git
 [submodule "scripts/Sparkle"]
 	path = scripts/Sparkle
 	url = https://github.com/sparkle-project/Sparkle
+[submodule "docs/_theme"]
+	path = docs/_theme
+	url = https://github.com/jbmorley/showcase-theme.git

.tool-versions

@@ -1 +1,2 @@
 python 3.12
+ruby 3.1.2

docs/404.md

@@ -0,0 +1,6 @@
+---
+title: Not Found
+layout: page
+---
+
+<p class="center">The page you requested could not be found.</p>

docs/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.2.0"
+gem "webrick", "~> 1.7"
+
+gem "theme", path: "_theme"
+
+group :jekyll_plugins do
+  gem 'jekyll-environment-variables'
+  gem "jekyll-feed", "~> 0.12"
+  gem "jekyll-image-size", "~> 1.2"
+  gem "jekyll-toc"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

docs/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: _theme
+  specs:
+    theme (0.5.0)
+      jekyll (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.3.7)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    fastimage (2.4.1)
+    ffi (1.17.4-arm64-darwin)
+    ffi (1.17.4-x86_64-darwin)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.1)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-environment-variables (1.0.1)
+      jekyll (>= 3.0, < 5.x)
+    jekyll-feed (0.17.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-image-size (1.2.1)
+      fastimage (>= 1.8)
+      jekyll (>= 3.7)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-toc (0.19.0)
+      jekyll (>= 3.9)
+      nokogiri (~> 1.12)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.5.2)
+      rexml (>= 3.4.4)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.10.0)
+      logger
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    mercenary (0.4.0)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (6.0.2)
+    racc (1.8.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rexml (3.4.4)
+    rouge (3.30.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+    webrick (1.9.2)
+
+PLATFORMS
+  arm64-darwin
+  x86_64-darwin
+
+DEPENDENCIES
+  jekyll (~> 4.2.0)
+  jekyll-environment-variables
+  jekyll-feed (~> 0.12)
+  jekyll-image-size (~> 1.2)
+  jekyll-toc
+  theme!
+  tzinfo (~> 1.2)
+  tzinfo-data
+  wdm (~> 0.1.1)
+  webrick (~> 1.7)
+
+BUNDLED WITH
+   2.6.9

docs/_config.yml

@@ -0,0 +1,41 @@
+theme: theme
+title: TinyBoard
+author: Jason Morley
+email: support@jbmorley.co.uk
+description: USB Keyboard Proxy
+image: images/screenshot-default-social@2x.png
+baseurl: ""
+url: "https://tinyboard.jbmorley.co.uk"
+repository: https://github.com/inseven/tinyboard
+copyright: 2022-2026 <a href="https://jbmorley.co.uk/about">Jason Morley</a>
+
+navigation:
+  - title: TinyBoard
+    href: /
+  - title: Releases
+    href: /releases
+  - title: GitHub
+    href: https://github.com/inseven/tinyboard
+  - title: Donate
+    href: https://jbmorley.co.uk/donate/
+
+footer:
+  - title: Privacy Policy
+    href: /privacy-policy
+  - title: Support
+    href: /support
+  - title: License
+    href: /license
+  - title: More Software
+    href: https://jbmorley.co.uk/software/
+
+plugins:
+  - jekyll-feed
+  - jekyll-environment-variables
+  - jekyll-toc
+  - jekyll-image-size
+destination: ../_site
+
+defaults:
+  - values:
+      layout: "page"

docs/assets/css/custom.css

@@ -0,0 +1,13 @@
+:root {
+    --brand-color: color(display-p3 0.542 0.364 0.796);
+    --showcase-color-high: color(display-p3 0.542 0.364 0.796);
+    --showcase-color-low: color(display-p3 0.303 0.124 0.557);
+}
+
+@media (prefers-color-scheme: dark) {
+    :root {
+        --brand-color: color(display-p3 0.542 0.364 0.796);
+        --showcase-color-high: color(display-p3 0.542 0.364 0.796);
+        --showcase-color-low: color(display-p3 0.303 0.124 0.557);
+    }
+}

docs/index.md

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{% include icon-header.html %}

docs/license/index.md

@@ -0,0 +1,11 @@
+---
+title: License
+---
+
+TinyBoard is licensed under the MIT License (see [LICENSE](https://github.com/inseven/tinyboard/blob/main/LICENSE)). It depends on the following separately licensed third-party libraries and components:
+
+- [Diligence](https://github.com/inseven/diligence), MIT License
+- [Glitter](https://github.com/inseven/glitter), MIT License
+- [Interact](https://github.com/inseven/interact), MIT License
+- [Licensable](https://github.com/inseven/licensable), MIT License
+- [Sparkle](https://github.com/sparkle-project/Sparkle), Sparkle License

docs/privacy-policy/index.md

@@ -0,0 +1,7 @@
+---
+title: Privacy Policy
+---
+
+TinyBoard does not collect or store any personal data.
+
+Should this policy change in the future, we will make all reasonable efforts to inform you and provide mechanisms to opt-out.

docs/support/index.md

@@ -0,0 +1,10 @@
+---
+title: Support
+---
+
+TinyBoard is developed in the open on [GitHub](https://github.com/inseven/tinyboard). I'd love your feedback so please feel free to join the discussion on [known issues](https://github.com/inseven/tinyboard/issues), raise a [new issue](https://github.com/inseven/tinyboard/issues/new), drop me an [email](mailto:support@jbmorley.co.uk?subject=TinyBoard%20Support), or reach out on [Mastodon](https://mastodon.me.uk/web/@jbmorley).
+
+- [Known Issues](https://github.com/inseven/tinyboard/issues)
+- [New Issue](https://github.com/inseven/tinyboard/issues/new)
+- [Email](mailto:support@jbmorley.co.uk?subject=TinyBoard%20Support)
+- [Mastodon](https://mastodon.me.uk/web/@jbmorley)