build: pin mkdocs<2 to stay clear of the MkDocs 2.0 rewrite#21
Merged
Conversation
MkDocs 2.0 is a backward-incompatible rewrite (no plugin system, no theme overrides, no migration path) that breaks Material for MkDocs. Material 9.7.5+ already caps mkdocs<2; make that explicit and bump the Material floor so a fresh resolve can never pull MkDocs 2.0. Docs continue to build on mkdocs 1.6.1 / mkdocs-material 9.7.6. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Why
The Material for MkDocs team is warning about MkDocs 2.0, a backward-incompatible ground-up rewrite of the core framework: it removes the plugin system, rewrites theming (breaking
custom_diroverrides), switches config to TOML, and has no migration path — Material ceases to work entirely. It's also currently unlicensed. See their analysis.This site relies on exactly what 2.0 breaks (
overrides/main.html,extra_css, markdown extensions).What
mkdocs>=1.6,<2constraint.mkdocs-materialfloor to>=9.7.5— the release that introduced themkdocs<2cap — so a fresh resolve can never pull MkDocs 2.0.uv.lock): resolves tomkdocs 1.6.1/mkdocs-material 9.7.6, unchanged from today.Verification
uv lock→mkdocs 1.6.1,mkdocs-material 9.7.6uv run mkdocs build→ cleanA Zensical (the Material team's successor) migration was spiked and shelved on
spike/zensical— it's viable but still alpha, so we stay on MkDocs 1.x for now.🤖 Generated with Claude Code