Add Nix Jekyll Build, GitHub Actions artifact, static Java site server

Author: msgilligan

.github/workflows/jekyll-build.yml

@@ -0,0 +1,40 @@
+name: Build Jekyll Site to Tarball
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+
+      - name: Setup Nix cache
+        uses: DeterminateSystems/magic-nix-cache-action@main
+
+      - name: Build site and create tarball
+        run: nix run .#tarball
+
+      - name: Upload tarball as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: bitcoinj-site-${{ github.sha }}
+          path: bitcoinj-site.tar.gz
+          retention-days: 30
+
+      - name: Create release on tag
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v1
+        with:
+          files: bitcoinj-site.tar.gz
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -7,6 +7,35 @@ This is the source-code repository for the **bitcoinj** website, published at [b
 
 This site is written in [GitHub-flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github), built using the [Jekyll static site generator](https://jekyllrb.com) and published via [GitHub Pages](https://pages.github.com).
 
+## Building locally in a Nix Shell
+
+The Nix development shell will install Jekyll for building and serving the site and Java 25 (if you want a simple Java-based tool to serve/test the static site.)
+
+1. Run `nix develop`
+2. Run `jekyll build`
+
+This will build the site into the `_site` directory.
+
+## Serving the site locally
+
+To serve the site with Jekyll and dynamic reloading:
+
+* `jekyll serve --livereload --incremental`
+
+To run a simple, local Java-based webserver to view the site use:
+
+* `./scripts/JekyllServer.java`
+
+## Building locally without Nix
+
+If you install Jekyll 3.10.0 and Ruby 3.3, you should be able to use the same commands as shown above, but this is untested/unsupported. You should also be able to serve the generated static site with the Java 25 script.
+
+## Building as a Nix Package
+
+* `nix build .#`
+
+This should build the package in `result`.
+
 ## Contributing
 
 To report a documentation issue or make a suggestion for improvement use [GitHub Issues](). You can also submit a [pull-request](https://github.com/bitcoinj/bitcoinj.github.io/pulls) for the website.

flake.lock

@@ -0,0 +1,94 @@
+{
+  description = "Development environment for bitcoinj.github.io Jekyll site";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/release-25.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+        
+        # Ruby environment with Jekyll and bundler
+        rubyEnv = pkgs.ruby_3_3.withPackages (ps: with ps; [
+          jekyll
+          kramdown-parser-gfm
+        ]);
+        
+      in
+      {
+        devShells.default = pkgs.mkShell {
+          buildInputs = with pkgs; [
+            rubyEnv
+            jdk25_headless
+          ];
+
+          shellHook = ''
+            echo "=== bitcoinj.github.io development environment ==="
+            echo ""
+            echo "Available commands:"
+            echo "  jekyll build                - Build the site to _site/"
+            echo "  jekyll serve                - Serve the site locally at http://localhost:4000"
+            echo "  jekyll serve --livereload   - Serve with auto-reload on changes"
+            echo "  ./scripts/JekyllServer.java - Serve the static site with a Java script"
+            echo ""
+          '';
+        };
+
+        # Package that builds the site
+        packages.default = pkgs.stdenv.mkDerivation {
+          pname = "bitcoinj-site";
+          version = "0.0.1";
+          
+          src = ./.;
+          
+          buildInputs = [ rubyEnv ];
+          
+          buildPhase = ''
+            export HOME=$TMPDIR
+            jekyll build
+          '';
+          
+          installPhase = ''
+            mkdir -p $out
+            cp -r _site/* $out/
+          '';
+        };
+
+        # App for easy site building
+        apps.build = {
+          type = "app";
+          program = "${pkgs.writeShellScript "build-site" ''
+            set -e
+            export HOME=$TMPDIR
+            ${rubyEnv}/bin/jekyll build
+            echo "Site built to _site/"
+          ''}";
+        };
+
+        apps.serve = {
+          type = "app";
+          program = "${pkgs.writeShellScript "serve-site" ''
+            set -e
+            export HOME=$TMPDIR
+            ${rubyEnv}/bin/jekyll serve --livereload
+          ''}";
+        };
+
+        apps.tarball = {
+          type = "app";
+          program = "${pkgs.writeShellScript "create-tarball" ''
+            set -e
+            export HOME=$TMPDIR
+            echo "Building site..."
+            ${rubyEnv}/bin/jekyll build
+            echo "Creating tarball..."
+            ${pkgs.gnutar}/bin/tar -czf bitcoinj-site.tar.gz -C _site .
+            echo "Tarball created: bitcoinj-site.tar.gz"
+          ''}";
+        };
+      }
+    );
+}