Skip to content

Update mkdocs-material from 8.1.3 to 9.8.0 - #317

Merged
clue merged 1 commit into
clue:mainfrom
clue-labs:mkdocs-update
Oct 29, 2026
Merged

clue merged 1 commit into
clue:mainfrom
clue-labs:mkdocs-update

Conversation

@clue

@clue clue commented Oct 29, 2026

Copy link
Copy Markdown
Owner

This changeset updates mkdocs-material from 8.1.3 (2021) to 9.8.0. Version 9 made the edit button, the previous/next footer and the code copy button opt-in, so this enables them again. Material for MkDocs reaches its end of life on May 5, 2027, with Zensical as its maintained successor.

I've compared every page before and after: search shows richer previews, tabbed code blocks are slightly more compact and the sidebar section headings are a bit lighter, otherwise the documentation looks the same.

Builds on top of #100 and #271

@clue clue added maintenance documentation Improvements or additions to documentation labels Oct 29, 2026
@clue clue added this to the v0.18.0 milestone Oct 29, 2026
@clue
clue requested a balanced review from Copilot October 29, 2026 11:27

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified for the documentation theme upgrade and explicit opt-in feature configuration.

No open issues 🎉

What changed in this PR

Updates the Docker Compose documentation setup to Material for MkDocs 9.8.0 while preserving features that became opt-in in version 9.

Changes:

  • Upgrades the documentation container image from 8.1.3 to 9.8.0.
  • Explicitly enables edit links, code-copy buttons, and previous/next footer navigation.
File Description
docs/​mkdocs.yml Enables the three opt-in theme features and removes trailing whitespace.
docs/​compose.yaml Updates the Material for MkDocs image to 9.8.0.

Review effort: Balanced

@clue
clue merged commit a4939b3 into clue:main Oct 29, 2026
75 checks passed
@clue
clue deleted the mkdocs-update branch October 29, 2026 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants