From f81aaa0502c2de159acb96b82cdb6b76292e679b Mon Sep 17 00:00:00 2001
From: Christoph Reiter <reiter.christoph@gmail.com>
Date: Thu, 4 Jun 2026 21:11:50 +0200
Subject: [PATCH] Move from mkdocs to properdocs

since mkdocs is abandoned, move to the fork.
See https://github.com/orgs/ProperDocs/discussions/33
---
 .github/workflows/main.yml |  2 +-
 README.md                  |  6 +++---
 pyproject.toml             |  4 +---
 uv.lock                    | 29 ++++++++++++++++++++++++++---
 4 files changed, 31 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index fa6578e9..fa757f7c 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -26,7 +26,7 @@ jobs:
         uses: astral-sh/setup-uv@v7
 
       - run: |
-          uv run mkdocs build
+          uv run properdocs build
           uv run python news2rss.py -f site/news/index.html -o site/news.xml
 
       - name: Upload for pages
diff --git a/README.md b/README.md
index 5050a6c8..a3f76f3a 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@
 ## Overview
 
 This website is written in Markdown and gets built to a static website using
-[mkdocs](https://www.mkdocs.org/) and a modified version of the [mkdocs-material
+[properdocs](https://properdocs.org/) and a modified version of the [mkdocs-material
 theme](https://squidfunk.github.io/mkdocs-material). Any new commits to the
 `main` branch will auto deploy to [GitHub pages](https://pages.github.com) using
 [a GitHub action](https://github.com/actions/deploy-pages). The resulting
@@ -29,14 +29,14 @@ For small changes:
 
 * Just use the online editor on GitHub and use the Markdown preview to inspect your changes
 * Open a PR with your changes in case you don't have commit rights
-* **Note:** The Markdown dialect and extensions understood by mkdocs and GitHub is
+* **Note:** The Markdown dialect and extensions understood by properdocs and GitHub is
   slightly different, so double check that the deployed website matches what you
   expected
 * **Note:** Every page on the website has a small "edit" icon in the top right corner which leads you straight to the online editor for that page
 
 For larger changes:
 
-* `uv run mkdocs serve`
+* `uv run properdocs serve`
 * Access http://127.0.0.1:8000 - any changes to the sources should be
   immediately visible in your browser
 * Open a PR with your changes or just push them if you have commit rights
diff --git a/pyproject.toml b/pyproject.toml
index 012748c8..d0ec11af 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,12 +4,10 @@ version = "1.0"
 description = ""
 authors = [{ name = "Christoph Reiter", email = "reiter.christoph@gmail.com" }]
 requires-python = ">=3.10,<4.0"
-dependencies = [
-]
 
 [dependency-groups]
 dev = [
-    "mkdocs>=1.1.2,<2",
+    "properdocs>=1.6.7,<2",
     "mkdocs-material>=9.5.0,<10",
     "mkdocs-redirects>=1.2.2",
     "beautifulsoup4>=4.13.4,<5",
diff --git a/uv.lock b/uv.lock
index 4ec84cb1..e57447e2 100644
--- a/uv.lock
+++ b/uv.lock
@@ -3,7 +3,7 @@ revision = 3
 requires-python = ">=3.10, <4.0"
 
 [options]
-exclude-newer = "2026-03-20T19:30:58.4499418Z"
+exclude-newer = "0001-01-01T00:00:00Z" # This has no effect and is included for backwards compatibility when using relative exclude-newer values.
 exclude-newer-span = "P7D"
 
 [[package]]
@@ -402,9 +402,9 @@ source = { virtual = "." }
 [package.dev-dependencies]
 dev = [
     { name = "beautifulsoup4" },
-    { name = "mkdocs" },
     { name = "mkdocs-material" },
     { name = "mkdocs-redirects" },
+    { name = "properdocs" },
 ]
 
 [package.metadata]
@@ -412,9 +412,9 @@ dev = [
 [package.metadata.requires-dev]
 dev = [
     { name = "beautifulsoup4", specifier = ">=4.13.4,<5" },
-    { name = "mkdocs", specifier = ">=1.1.2,<2" },
     { name = "mkdocs-material", specifier = ">=9.5.0,<10" },
     { name = "mkdocs-redirects", specifier = ">=1.2.2" },
+    { name = "properdocs", specifier = ">=1.6.7,<2" },
 ]
 
 [[package]]
@@ -453,6 +453,29 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/63/d7/97f7e3a6abb67d8080dd406fd4df842c2be0efaf712d1c899c32a075027c/platformdirs-4.9.4-py3-none-any.whl", hash = "sha256:68a9a4619a666ea6439f2ff250c12a853cd1cbd5158d258bd824a7df6be2f868", size = 21216, upload-time = "2026-03-05T18:34:12.172Z" },
 ]
 
+[[package]]
+name = "properdocs"
+version = "1.6.7"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+    { name = "ghp-import" },
+    { name = "jinja2" },
+    { name = "markdown" },
+    { name = "markupsafe" },
+    { name = "packaging" },
+    { name = "pathspec" },
+    { name = "platformdirs" },
+    { name = "pyyaml" },
+    { name = "pyyaml-env-tag" },
+    { name = "watchdog" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/ec/29/f27a4e1eddf72ed3db6e47818fbafe6debbf09fd7051f9c1a007239b46ef/properdocs-1.6.7.tar.gz", hash = "sha256:adc7b16e562890af0e098a7e5b02e3a81c20894a87d6a28d345c9300de73c26e", size = 276141, upload-time = "2026-03-20T20:07:48.167Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/bd/4d/fc923f5c85318ee8cc903566dc4e0ebe41b2dfc1d2ecf5546db232397ed6/properdocs-1.6.7-py3-none-any.whl", hash = "sha256:6fa0cfa2e01bf338f684892c8a506cf70ea88ae7f3479c933b6fa20168101cbd", size = 225406, upload-time = "2026-03-20T20:07:46.875Z" },
+]
+
 [[package]]
 name = "pygments"
 version = "2.19.2"