Skip to content

Upgrading mkdocs-material 5 to 6

Breaking5.5.14 → 6.2.8Breaking3Security1New10Changed12Fixed31Other1

BreakingUpgrade verdict

3 breaking changes and a security fix.

  • Users of the Docker image can no longer select the mkdocs or readthedocs themes.
  • The built-in hero template is gone; themes that relied on it must provide their own.
  • Old front matter options that were already deprecated no longer work.
  • Link tooltips are now escaped to prevent unsafe content from being injected.
4 items need code or config changes
Breaking3
Removes the mkdocs and readthedocs themes from the Docker image.
mkdocsreadthedocs
Removes the hero partial in favor of a custom implementation.
hero
Removes deprecated front matter features.
Security1
Adds escaping for link title attributes where necessary.