Merge pull request #10 from geographika/zensical

Switch from mkdocs to zensical

Author: geographika

.github/workflows/deploy.app.yml

@@ -17,7 +17,7 @@ jobs:
     name: Build and Deploy JavaScript application
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
       - name: Build website
         run: |
           npm install

.github/workflows/deploy.docs.yml

@@ -1,28 +1,40 @@
-name: Deploy documentation ⚙️
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - 'workshop/content/**'
-
-defaults:
-  run:
-    working-directory: workshop/content
-
-jobs:
-  build:
-    name: Build and Deploy Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
-      - name: Install requirements 📦
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-      - name: Deploy 📦
-        run: mkdocs gh-deploy --strict --force --message 'update website via GitHub Actions'
+name: Deploy documentation ⚙️
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'workshop/content/**'
+
+jobs:
+  build:
+    name: Build and Deploy Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+      - name: Install requirements 📦
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r workshop/content/requirements.txt
+      - name: Build site 📦
+        run: |
+          zensical build --clean --strict
+          mv site /tmp/
+      - name: checkout gh-pages branch
+        uses: actions/checkout@master
+        with:
+          ref: gh-pages
+      - name: Deploy to GitHub Pages 📦
+        run: |
+          git checkout gh-pages
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          ls | grep -v ".nojekyll"| xargs rm -fr
+          mv -f /tmp/site/* .
+          git add .
+          git commit -am "update website via GitHub Actions"
+          git push

.github/workflows/tests.yml

@@ -1,26 +1,26 @@
-name: Test documentation ⚙️
-
-on:
-  pull_request:
-    paths:
-      - 'workshop/content/**'
-
-defaults:
-  run:
-    working-directory: workshop/content
-
-jobs:
-  build:
-    name: Test documentation build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
-      - name: Install requirements 📦
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-      - name: Deploy 📦
-        run: mkdocs build --strict
+name: Test documentation ⚙️
+
+on:
+  pull_request:
+    paths:
+      - 'workshop/content/**'
+
+defaults:
+  run:
+    working-directory: workshop/content
+
+jobs:
+  build:
+    name: Test documentation build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+      - name: Install requirements 📦
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Deploy 📦
+        run: zensical build --clean --strict

README.md

@@ -27,7 +27,7 @@ the [Workshop environment setup](https://mapserver.github.io/getting-started-wit
 
 ### Building the workshop content locally
 
-The workshop manual is powered by [MkDocs](https://www.mkdocs.org) which facilitates easy management
+The workshop manual is powered by [Zensical](https://zensical.org) which facilitates easy management
 of content and publishing. Workshop content is written in Markdown.
 
 
@@ -43,9 +43,9 @@ cd getting-started-with-mapserver/workshop/content
 # install required dependencies
 pip install -r requirements.txt
 # build the website
-mkdocs build
+zensical build
 # serve locally
-mkdocs serve  # website is made available on http://localhost:8000
+zensical serve  # website is made available on http://localhost:8000
 ```
 
 ## Contributing updates
@@ -56,10 +56,4 @@ Changes to the GitHub repository result in an automated build and deploy of the
 
 ## Deploying to live site
 
-Website updates are automatically published via GitHub Actions. To publish manually:
-
-```bash
-# NOTE: you require access privileges to the GitHub repository
-# to publish live updates
-mkdocs gh-deploy -m 'add new page on topic x'
-```
+Website updates are automatically published via GitHub Actions.