Switch from MkDocs to Zensical

.github/workflows/main.yml

@@ -25,7 +25,7 @@ jobs:
       run: sudo npm i -g markdownlint-cli2@latest
     - name: Run markdownlint-cli2 to check Markdown files
       run: markdownlint-cli2 '**.md'
-    - name: Install MkDocs and PySpelling
+    - name: Install Zensical and PySpelling
       id: python
       if: always() && steps.clone.outcome == 'success'
       uses: actions/setup-python@v6
@@ -36,7 +36,7 @@ jobs:
     - name: Build DietPi-Docs
       id: build
       if: always() && steps.python.outcome == 'success'
-      run: mkdocs build -sd build/docs
+      run: zensical build -c
     - name: Install Aspell
       id: aspell
       if: always() && steps.build.outcome == 'success'

.wordlist.txt

@@ -857,6 +857,7 @@ YDNS
 yescrypt
 ympd
 youtube
+Zensical
 Zeroconf
 ZeroPi
 ZeroTier

README.md

@@ -16,16 +16,16 @@
 ## Introduction
 
 This is the source code repository for the [DietPi Documentation website](https://dietpi.com/docs/).
-It uses extended Markdown, as implemented by [MkDocs](https://www.mkdocs.org/).
+It uses extended Markdown, as implemented by [Zensical](https://zensical.org/).
 
 [![CodeFactor](https://www.codefactor.io/repository/github/michaing/dietpi-docs/badge)](https://www.codefactor.io/repository/github/michaing/dietpi-docs)
 
 ## Building the documentation
 
 - Install/update dependencies: `python3 -m pip install -Ur requirements.txt`
-- From the root directory, run: `python3 -m mkdocs serve`
+- From the root directory, run: `python3 -m zensical serve`
 
-It builds the static HTML pages into a temporary directory and starts a local web server at `http://localhost:8000`. If you have troubles accessing the MkDocs website, you could also listen on a specific IP address or all IP addresses, e.g. `mkdocs serve -a 0.0.0.0:8000`.
+It builds the static HTML pages into a temporary directory and starts a local web server at `http://localhost:8000`. If you have troubles accessing the Zensical website, you could also listen on a specific IP address or all IP addresses, e.g. `zensical serve -a 0.0.0.0:8000`.
 
 ## Contributing
 

mkdocs.yml

@@ -9,6 +9,7 @@ repo_name: DietPi-Docs
 repo_url: https://github.com/MichaIng/DietPi-Docs
 edit_uri: edit/dev/docs/
 docs_dir: docs
+site_dir: build/docs
 watch: 
 - snippet-includes
 

requirements.txt

@@ -1,3 +1,3 @@
-mkdocs>=1.4.2
-mkdocs-material>=9.0.4
+zensical>=0.0.23
+mkdocs-material>=9.7.2
 mkdocs-minify-plugin>=0.6.2

snippet-includes/AvahiDaemon-WebInterface-access_infoblock.md

@@ -1,3 +1,3 @@
 ??? info "Using `<hostname>.local` instead of using `<your.IP>` (Avahi-Daemon)"
 
-    By installing Avahi-Daemon, the web interface can be accessed with `<hostname>.local` (default: `dietpi.local`) instead of using `<your.IP>`. See the [Avahi-Daemon documentation](./advanced_networking.md/#avahi-daemon) for details.
+    By installing Avahi-Daemon, the web interface can be accessed with `<hostname>.local` (default: `dietpi.local`) instead of using `<your.IP>`. See the [Avahi-Daemon documentation](advanced_networking.md/#avahi-daemon) for details.