From c0711547d95627e20dc31adda0d3e08498ccc134 Mon Sep 17 00:00:00 2001 From: yubiuser Date: Mon, 17 Nov 2025 19:55:25 +0100 Subject: [PATCH] Switch from mkdocs-material to zensical Signed-off-by: yubiuser --- .devcontainer/Dockerfile | 2 +- mkdocs.yml | 2 -- netlify.toml | 2 +- package.json | 4 ++-- requirements.txt | 5 ++--- 5 files changed, 6 insertions(+), 9 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 9e2e9d0..88c4498 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -10,6 +10,6 @@ RUN apk add --no-cache \ ENV USER node USER ${USER} -# python packages (as mkdocs) are installed in the user's home directory +# python packages (as zensical) are installed in the user's home directory # but we need them to be accessible from ${PATH} ENV PATH="${PATH}:/home/${USER}/.local/bin" diff --git a/mkdocs.yml b/mkdocs.yml index e5c157f..8676d19 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -94,8 +94,6 @@ markdown_extensions: auto_append: - docs/abbreviations.md # Include files in other documents like {!some/dir/in/docs/filename.md!} - - markdown_include.include: - base_path: docs # Metadata support in pages # (https://squidfunk.github.io/mkdocs-material/extensions/metadata/) - meta diff --git a/netlify.toml b/netlify.toml index 48742a5..eed0088 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,7 +1,7 @@ [build] base = "/" publish = "site/" -command = "mkdocs build --clean --strict" +command = "zensical build --clean --strict" [build.environment] PYTHON_VERSION = "3.14" diff --git a/package.json b/package.json index 3582e87..d8410c5 100644 --- a/package.json +++ b/package.json @@ -16,12 +16,12 @@ }, "homepage": "https://docs.pi-hole.net/", "scripts": { - "build": "mkdocs build --clean --strict", + "build": "zensical build --clean --strict", "markdownlint": "markdownlint-cli2 \"**/*.md\" \"!**/node_modules/**\"", "linkinator": "linkinator site --recurse --silent --skip \"^(?!http://localhost)\"", "pretest": "npm run build", "test": "npm run markdownlint && npm run linkinator", - "serve": "mkdocs serve --dev-addr 0.0.0.0:8000", + "serve": "zensical serve --dev-addr 0.0.0.0:8000", "start": "npm run serve" }, "devDependencies": { diff --git a/requirements.txt b/requirements.txt index 51f7483..424e520 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ -mkdocs==1.6.1 -mkdocs-git-revision-date-localized-plugin==1.5.1 -mkdocs-material==9.7.6 +zensical==0.0.8 +mkdocs-git-revision-date-localized-plugin==1.5.0 mkdocs-redirects==1.2.2 markdown-include==0.8.1