Upgrade

Component Current Version Latest Version Target Version
Mkdocs >=1.1.2 (=1.5.3) 1.6.0 1.6.0
Material Theme 8.5.11 9.5.22 9.5.22
html-proofer-plugin 1.2.1 1.2.1 1.2.1
mkdocs-video 1.3.0 1.5.0 1.5.0
Python 3.8 3.12

Material Theme

  • How to upgrade
  • New features
    • This major release includes a brand new search implementation that is faster and allows for rich previews, advanced tokenization and better highlighting. ref.

    • The copy-to-clipboard buttons are now opt-in and can be enabled or disabled per block. ref.

Mkdocs

  • Release notes
    • Read, what is relevant for us?
    • Tip: Simply upgrading to Python 3.11 can cut off 10-15% of your site's build time.

    • Python 3.12 is officially supported.

  • New features
    • Anchor validation (>v1.5)
      • Check new configuration options
      • Do we still need html-proofer-plugin or is it obsolete now?
        • Yes! External urls are not checked by mkdocs.

mkdocs-video

  • https://github.com/soulless-viewer/mkdocs-video
  • This project is no longer maintained. You can still use it, but there will be no more updates.

  • Last version: 1.5.0
  • Are videos still working? Locally, there is a "not support file type" error message.

Markdownlint

  • RUN npm install -g markdownlint-cli@0.32.2 markdown-link-check
    • Check: Do we still use these tools?
      • Yes, we do!
    • If so, do we want to update?
      • Yes, we want
      • E.g. 0.40.0: Line length is now also checked in admonitions
Edited by Martin Schroschk