From 74204c06c099d621245d28af1f895a0b359529d2 Mon Sep 17 00:00:00 2001 From: MichaIng Date: Sat, 21 Feb 2026 14:49:10 +0100 Subject: [PATCH 1/3] Switch from MkDocs to Zensical MkDocs is dead, but Zensical from the mkdocs-material developer is an active fork. Also, install Zensical and PySpelling directly with the setup-python action, and assure latest markdownlint-cli2 is used. --- .github/workflows/main.yml | 4 ++-- README.md | 6 +++--- requirements.txt | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 84c705fd8..06ad1faa3 100644 --- a/.github/workflows/main.yml +++ b/.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 -sd build/docs - name: Install Aspell id: aspell if: always() && steps.build.outcome == 'success' diff --git a/README.md b/README.md index 4316bac89..a70d5cc16 100644 --- a/README.md +++ b/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 diff --git a/requirements.txt b/requirements.txt index c8e88ead7..47bb6d01f 100644 --- a/requirements.txt +++ b/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 From 9a91b7df4828c38d4f6ae68866ed93b482f32897 Mon Sep 17 00:00:00 2001 From: MichaIng Date: Sat, 21 Feb 2026 15:27:54 +0100 Subject: [PATCH 2/3] fix: use site_dir instead of CLI for target dir Zensical does not support the "-d" option to specify the target directory. Instead of site_dir setting needs to be used. --- .github/workflows/main.yml | 2 +- mkdocs.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 06ad1faa3..6da7df4f2 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -36,7 +36,7 @@ jobs: - name: Build DietPi-Docs id: build if: always() && steps.python.outcome == 'success' - run: zensical build -sd build/docs + run: zensical build -c - name: Install Aspell id: aspell if: always() && steps.build.outcome == 'success' diff --git a/mkdocs.yml b/mkdocs.yml index 7398936a2..c22bf54d9 100644 --- a/mkdocs.yml +++ b/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 From 3f0fea2e8ee122544be472be052973652277f657 Mon Sep 17 00:00:00 2001 From: MichaIng Date: Sat, 21 Feb 2026 16:15:28 +0100 Subject: [PATCH 3/3] Attempt to fix relative link from snippet --- .wordlist.txt | 1 + snippet-includes/AvahiDaemon-WebInterface-access_infoblock.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.wordlist.txt b/.wordlist.txt index 543342323..9b0dd54eb 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -857,6 +857,7 @@ YDNS yescrypt ympd youtube +Zensical Zeroconf ZeroPi ZeroTier diff --git a/snippet-includes/AvahiDaemon-WebInterface-access_infoblock.md b/snippet-includes/AvahiDaemon-WebInterface-access_infoblock.md index 764da289e..d5a733b9b 100644 --- a/snippet-includes/AvahiDaemon-WebInterface-access_infoblock.md +++ b/snippet-includes/AvahiDaemon-WebInterface-access_infoblock.md @@ -1,3 +1,3 @@ ??? info "Using `.local` instead of using `` (Avahi-Daemon)" - By installing Avahi-Daemon, the web interface can be accessed with `.local` (default: `dietpi.local`) instead of using ``. See the [Avahi-Daemon documentation](./advanced_networking.md/#avahi-daemon) for details. + By installing Avahi-Daemon, the web interface can be accessed with `.local` (default: `dietpi.local`) instead of using ``. See the [Avahi-Daemon documentation](advanced_networking.md/#avahi-daemon) for details.