From f3512d50dfd2498e6a54e8bc6c651e8c0895a430 Mon Sep 17 00:00:00 2001 From: Florian Preinstorfer Date: Wed, 25 Mar 2026 16:23:40 +0100 Subject: [PATCH] Switch to mkdocs-materialx The project mkdocs-material is in maintenance-only mode and their successor is not ready yet. Use the modern, refreshed theme and drop the pymdownx.magiclink extension. --- config-example.yaml | 1 + docs/requirements.txt | 8 ++++---- mkdocs.yml | 6 +----- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/config-example.yaml b/config-example.yaml index bf47e82d..b94f3c8a 100644 --- a/config-example.yaml +++ b/config-example.yaml @@ -432,6 +432,7 @@ taildrop: # When enabled, nodes can send files to other nodes owned by the same user. # Tagged devices and cross-user transfers are not permitted by Tailscale clients. enabled: true + # Advanced performance tuning parameters. # The defaults are carefully chosen and should rarely need adjustment. # Only modify these if you have identified a specific performance issue. diff --git a/docs/requirements.txt b/docs/requirements.txt index 65174cd4..da6c76f5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,6 @@ mike~=2.1 -mkdocs-include-markdown-plugin~=7.1 -mkdocs-macros-plugin~=1.3 -mkdocs-material[imaging]~=9.5 -mkdocs-minify-plugin~=0.7 +mkdocs-include-markdown-plugin~=7.2 +mkdocs-macros-plugin~=1.5 +mkdocs-materialx[imaging]~=10.1 +mkdocs-minify-plugin~=0.8 mkdocs-redirects~=1.2 diff --git a/mkdocs.yml b/mkdocs.yml index d94a5d7e..2d92f140 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,7 @@ copyright: Copyright © 2026 Headscale authors # Configuration theme: - name: material + name: materialx features: - announce.dismiss - content.action.edit @@ -138,10 +138,6 @@ markdown_extensions: pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - - pymdownx.magiclink: - repo_url_shorthand: true - user: squidfunk - repo: mkdocs-material - pymdownx.mark - pymdownx.smartsymbols - pymdownx.superfences: