Skip to content

Upgrading mkdocs-material 6 to 7

Breaking6.2.8 → 7.3.6Breaking1Security2Deprecated2New22Changed17Fixed71Other3

Full comparisonBack to mkdocs-material
BreakingUpgrade verdict

1 breaking change and 2 security fixes.

In plain terms
  • Any custom code listening for the DOMContentSwitch event will stop receiving it.
  • Updates the underlying documentation tool to a version that fixes a known security vulnerability.
  • The Docker image now refreshes its package index during build, so it picks up security updates.
  • Building the search index ahead of time is now discouraged.
Must act 5 items need code or config changes

Adds jinja2 >=2.11.1.

What you must change

Breaking1
Removes the DOMContentSwitch event.
DOMContentSwitch
7.0.0b2GitHub ReleaseSummarizedView source
Security2
Bumps MkDocs to 1.2.3 to mitigate CVE-2021-40978.
MkDocs
7.3.4GitHub ReleaseSummarizedView source
Improves Docker image security by always updating apk.
7.0.6GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated2
Deprecates prebuilding of the search index.
7.3.2GitHub ReleaseSummarizedView source
Deprecates the seealso admonition qualifier.
seealso
7.1.6GitHub ReleaseSummarizedView source