From 03e5fef78f8361e0b70b8974ef6cfe5efc6e1558 Mon Sep 17 00:00:00 2001 From: ebner Date: Thu, 4 Dec 2025 15:29:14 +0100 Subject: [PATCH] update readme --- Readme.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/Readme.md b/Readme.md index d53fc7e..47d6d40 100644 --- a/Readme.md +++ b/Readme.md @@ -1,29 +1,50 @@ # Overview -Alpine based image to build jupyter-book based documentation +Alpine based image to build zensical - https://zensical.org - based documentation Build manually: ```bash docker run -it --rm -v $(pwd):/data --workdir /data gitea.psi.ch/images/alpine-zensical -/opt/python-env/bin/zensical build --site-dir public +/opt/python-env/bin/zensical build ``` -Use Gitea action to build the documentation: +Use Gitea/Github action to build the documentation: ```yaml +name: Build and Publish Site + +on: + push: + branches: + - main + workflow_dispatch: + jobs: - build-and-deploy: + docker: runs-on: ubuntu-latest-intranet container: image: gitea.psi.ch/images/alpine-zensical steps: - - name: Checkout repository + - name: Checkout uses: actions/checkout@v4 - - name: Build Jupyter Book - run: /opt/python-env/bin/zensical build --site-dir public + - name: Run mkdocs + run: /opt/python-env/bin/zensical build + - name: Configure Git + run: | + git config --global user.name "Gitea Actions" + git config --global user.email "actions@gitea.local" + + - name: Push to gitea-pages branch + run: | + git checkout --orphan gitea-pages + git reset --hard + mv site/* . + git add . + git commit -m "Update site - $(date)" + git push -f https://${{secrets.GITHUB_TOKEN}}@gitea.psi.ch/${{ github.repository }}.git gitea-pages ```