add pagefind section to README

Signed-off-by: Christoph Rueger <[email protected]>

Author: chrisrueger

README.md

@@ -16,6 +16,40 @@ This should install jekyll and start a local webserver at:
 
 Start editing markdown `.md` files. Jekyll will auto-detect changes and reload the website. Some changes require a restart (e.g. changes to `_config.yml`)
 
+## Local development with Pagefind search
+
+We use https://pagefind.app/ for our search field full text search. 
+But it is currently not automatically working when using `./run.sh` above, because it works on the 
+actual build-output on the `_site` folder (which contains the actual `.html` pages). 
+
+To test the search locally based on the `_site` folder content, run:
+
+
+`./run-pagefind-linux.sh`
+
+or
+
+`run-pagefind-macos.sh`
+
+depending on which operating system you are using. 
+
+The result should look like:
+
+`Serving "_site" at http://localhost:1414`
+
+
+The script will download and execute the pagefind executable binary after the build.
+Then it will start a small server where you test the result. 
+Note, that this is different than the `./run.sh` and does not support real-time editing of the content.
+
+Feel free to adjust / extend the start-scripts if you have a different architecture 
+or to use a different `pagefind` version. 
+
+### pagefind for production build via github actions
+
+See the files `.github/workflows/cibuild.yml` and `.github/scripts/docs.sh` for how 
+building the site and executing `pagefind` is done in the final build on github.
+
 ### CSS Styling for Code Highlighter
 
 - jekyll uses `rouge` code highlighter

run-pagefind.sh renamed to run-pagefind-linux.sh

@@ -5,7 +5,11 @@ set -ev
 export BUNDLE_GEMFILE=$PWD/Gemfile
 bundle install --jobs=3 --retry=3 --path=vendor
 bundle exec jekyll clean
-bundle exec jekyll build -w --incremental 
+bundle exec jekyll build
 
 # Run and serve the _site folder with search working
+# install Linux x86_64
+curl -L https://github.com/CloudCannon/pagefind/releases/download/v1.3.0/pagefind-v1.3.0-x86_64-unknown-linux-musl.tar.gz -o pagefind.tar.gz
+tar xzf pagefind.tar.gz
+chmod +x pagefind
 ./pagefind --site _site --serve

run-pagefind-macos.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -ev
+
+# Build into _site folder
+export BUNDLE_GEMFILE=$PWD/Gemfile
+bundle install --jobs=3 --retry=3 --path=vendor
+bundle exec jekyll clean
+bundle exec jekyll build
+
+# Run and serve the _site folder with search working
+# install for MacOS aarch64
+curl -L https://github.com/CloudCannon/pagefind/releases/download/v1.3.0/pagefind-v1.3.0-aarch64-apple-darwin.tar.gz -o pagefind.tar.gz
+tar xzf pagefind.tar.gz
+chmod +x pagefind
+./pagefind --site _site --serve