Repository navigation
Update mkdocs-material from 8.1.3 to 9.8.0 - #317
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 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.3to9.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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This changeset updates mkdocs-material from
8.1.3(2021) to9.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