fix(deps): update dependency mkdocs-material to v9
This MR contains the following updates:
| Package | Change | Age | Confidence |
|---|---|---|---|
| mkdocs-material (changelog) |
~=4.0 -> ~=9.7
|
Release Notes
squidfunk/mkdocs-material (mkdocs-material)
v9.7.0: mkdocs-material-9.7.0
[!WARNING]
Material for MkDocs is now in maintenance mode
This is the last release of Material for MkDocs that will receive new features. Going forward, the Material for MkDocs team focuses on Zensical, a next-gen static site generator built from first principles. We will provide critical bug fixes and security updates for Material for MkDocs for 12 months at least.
→ Read the full announcement on our blog
This release includes all features that were previously exclusive to the Insiders edition. These features are now freely available to everyone.
Note on deprecated plugins: The projects and typeset plugins are included in this release, but must be considered deprecated. Both plugins proved unsustainable to maintain and represent architectural dead ends. They are provided as-is without ongoing support.
Changes:
- Added support for projects plugin (for compat, now deprecated)
- Added support for typeset plugin (for compat, now deprecated)
- Added support for pinned blog posts and author profiles
- Added support for customizing pagination for blog index pages
- Added support for customizing blog category sort order
- Added support for staying on page when switching languages
- Added support for disabling tags in table of contents
- Added support for nested tags and shadow tags
- Added support for footnote tooltips
- Added support for instant previews
- Added support for instant prefetching
- Added support for custom social card layouts
- Added support for custom social card background images
- Added support for selectable rangs in code blocks
- Added support for custom selectors for code annotations
- Added support for configurable log level in privacy plugin
- Added support for processing of external links in privacy plugin
- Added support for automatic image optimization via optimize plugin
- Added support for navigation paths (breadcrumbs)
- Fixed #8519: Vector accents do not render when using KaTeX
v9.6.23: mkdocs-material-9.6.23
- Updated Burmese translation
v9.6.22: mkdocs-material-9.6.22
- Updated Georgian translation
v9.6.21: mkdocs-material-9.6.21
- Updated Serbian translations
- Fixed #8458: Temporary pin of click dependency
v9.6.20: mkdocs-material-9.6.20
- Fixed #8446: Deprecation warning as of Python 3.14 in Emoji extension
- Fixed #8440:
&character not escaped in search highlighting - Fixed #8439: FontAwesome icons color not set in social cards (regression)
v9.6.19: mkdocs-material-9.6.19
- Added support for Python 3.14
- Updated Bahasa Malaysia translations
v9.6.18: mkdocs-material-9.6.18
- Updated Azerbaijani translations
- Fixed last compat issues with minijinja, now 100% compatible
v9.6.17: mkdocs-material-9.6.17
- Fixed #8396: Videos do not autoplay when inside a content tab
- Fixed #8394: Stroke width not effective in Mermaid.js diagrams
- Fixed disappearing version selector when hiding page title
v9.6.16: mkdocs-material-9.6.16
- Fixed #8349: Info plugin doesn't correctly detect virtualenv in some cases
- Fixed #8334: Find-in-page detects matches in hidden search result list
v9.6.15: mkdocs-material-9.6.15
- Updated Mongolian translations
- Improved semantic markup of "edit this page" button
- Improved info plugin virtual environment resolution
- Fixed #8291: Large font size setting throws of breakpoints in JavaScript
v9.6.14: mkdocs-material-9.6.14
- Fixed #8215: Social plugin crashes when CairoSVG is updated to 2.8
v9.6.13: mkdocs-material-9.6.13
- Fixed #8204: Annotations showing list markers in print view
- Fixed #8153: Improve style of cardinality symbols in Mermaid.js ER diagrams
v9.6.12: mkdocs-material-9.6.12
- Fixed #8158: Flip footnote back reference icon for right-to-left languages
v9.6.11: mkdocs-material-9.6.11
- Updated Docker image to latest Alpine Linux
- Bump required Jinja version to 3.1
- Fixed #8133: Jinja filter
itemsnot available (9.6.10 regression) - Fixed #8128: Search plugin not entirely disabled via enabled setting
v9.6.10: mkdocs-material-9.6.10
This version is a pure refactoring release, and does not contain new features or bug fixes. It strives to improve the compatibility of our templates with alternative Jinja-like template engines that we're currently exploring, including minijinja.
Additionally, it replaces several instances of Python function invocations with idiomatic use of template filters. All instances where variables have been mutated inside templates have been replaced. Most changes have been made in partials, and only a few in blocks, and all of them are fully backward compatible, so no changes to overrides are necessary.
Note that this release does not replace the Jinja template engine with minijinja. However, our templates are now 99% compatible with minijinja, which means we can explore alternative Jinja-compatible implementations. Additionally, immutability and removal of almost all Python function invocations means much more idiomatic templating.
v9.6.9: mkdocs-material-9.6.9
- Updated Serbo-Croatian translations
- Fixed #8086: Custom SVG icons containing hashes break rendering
- Fixed #8067: Drawer has gap on right side in Firefox on some OSs
v9.6.8: mkdocs-material-9.6.8
- Added Welsh translations
- Fixed #8076: Privacy plugin crashes if HTTP download fails
v9.6.7: mkdocs-material-9.6.7
- Fixed #8056: Error in backrefs implementation (9.6.6 regression)
- Fixed #8054: Unescaped quotes in ARIA labels of table of contents
v9.6.6: mkdocs-material-9.6.6
- Fixed #8040: Privacy plugin not replacing exteral assets (9.6.5 regression)
- Fixed #8031: Replace unmaintained
regexpackage in search plugin
v9.6.5: mkdocs-material-9.6.5
- Fixed #8016: Tags listing not showing when when file name has spaces
- Fixed #8012: Privacy plugin crashes if HTTP download fails
v9.6.4: mkdocs-material-9.6.4
- Fixed #7985: Blog content sometimes not stretching to full width
- Fixed #7978: Navigation rendering bug in Safari 18.3
v9.6.3: mkdocs-material-9.6.3
- Fixed rendering of arrow heads in Mermaid.js class diagrams
- Fixed #7960: Tags plugin crashes on numeric metadata titles
v9.6.2: mkdocs-material-9.6.2
- Fixed #7955: Excessively long words don't break on narrow screens
- Fixed #7947: Scope setting interferes with outdated version banner
v9.6.1: mkdocs-material-9.6.1
- Fixed #7943: Tags plugin crashing due to merge error
v9.6.0: mkdocs-material-9.6.0
- Added meta plugin
- Rewrite of the tags plugin
- Added support for allow lists in tags plugin
- Added support for and custom sorting in tags plugin
- Added support for related links in blog plugin
- Added support for custom index pages in blog plugin
- Added support for navigation subtitles
- Fixed #7924: Anchors might require two clicks when using instant navigation
v9.5.50: mkdocs-material-9.5.50
- Fixed #7913: Social plugin renders attribute lists in page title
v9.5.49: mkdocs-material-9.5.49
- Adjusted title color in dark mode for all supported Mermaid.js diagrams
- Fixed #7803: Privacy plugin crashes on generated files
- Fixed #7781: Mermaid.js flow chart title not visible in dark mode
v9.5.48: mkdocs-material-9.5.48
- Fixed #7774: Disabling social cards doesn't work
v9.5.47: mkdocs-material-9.5.47
- Fixed #7750: Numeric tags break search
- Fixed #7748: Blog plugin breaks when using future drafts (9.5.45 regression)
Thanks go to @perpil for their contributions
v9.5.46: mkdocs-material-9.5.46
- Added support for removing
preloadhints in privacy plugin - Fixed #7734: Code blocks in h5 headlines are uppercased
- Fixed #7725: Blog plugin crashing on missing timezone (9.5.45 regression)
Thanks go to @nejch and @perpil for their contributions
v9.5.45: mkdocs-material-9.5.45
- Reduced size of Docker image through multi-stage build
- Fixed #7708: Blog plugin crashing on YAML dates with timezones
Thanks go to @FrancoisCapon and @perpil for their contributions
v9.5.44: mkdocs-material-9.5.44
- Fixed #7672: Font CSS 404's when using privacy plugin (9.5.43 regression)
Thanks go to @nejch for their contributions.
v9.5.43: mkdocs-material-9.5.43
- Added support for external images in SVGs in privacy plugin
- Fixed #7651: Privacy plugin doesn't handle quoted URLs in CSS
Thanks go to @nejch for their contributions
v9.5.42: mkdocs-material-9.5.42
- Fixed #7625: Invalid encoding of boolean attributes in privacy plugin
- Fixed #7624: Crash when disabling privacy plugin (9.5.41 regression)
v9.5.41: mkdocs-material-9.5.41
- Fixed #7619: Improved tooltip on logo disappears after instant navigation
- Fixed #7616: Race condition in built-in privacy plugin when inlining assets
- Fixed #7615: Comments and "Was this page helpful?" visible when printing
v9.5.40: mkdocs-material-9.5.40
- Updated Latvian translations
- Fixed #7597: Social cards not using site name on home page
Thanks go to @pekkaklarck and @klejejs for their contributions
v9.5.39: mkdocs-material-9.5.39
- Fixed #7226: not staying on page when using mike's canonical versioning
Thanks go to @ilyagr for their contributions
v9.5.38: mkdocs-material-9.5.38
- Added Albanian translations
Thanks go to @gerardkraja for their contributions
v9.5.37: mkdocs-material-9.5.37
- Added 4th and 5th level ordered list styles
- Fixed #7548: Tags have no spacing in search
v9.5.36: mkdocs-material-9.5.36
- Fixed #7544: Social cards incorrectly rendering HTML entities
- Fixed #7542: Improved support for setting custom list styles
v9.5.35: mkdocs-material-9.5.35
- Fixed #7498: Search not showing for Vietnamese language
v9.5.34: mkdocs-material-9.5.34
- Updated Mermaid.js to version 11 (latest)
Thanks go to @manselmi for their contributions
v9.5.33: mkdocs-material-9.5.33
- Fixed #7453: Incorrect position of tooltip when sorting table
v9.5.32: mkdocs-material-9.5.32
- Fixed RXSS vulnerability via deep link in search results
- Added support for fetching latest release from GitLab
Thanks go to @joaopalmeiro for their contributions
v9.5.31: mkdocs-material-9.5.31
- Fixed #7405: DockerHub missing images > 9.5.27 due to change in Alpine/APK
v9.5.30: mkdocs-material-9.5.30
- Fixed #7380: Navigation icons disappearing on hover in Safari
- Fixed #7367: Blog readtime computation includes SVG text content
Thanks go to @sisp for their contributions
v9.5.29: mkdocs-material-9.5.29
- Updated Galician translations
- Fixed #7362: Annotations in figure captions rendering incorrectly
Thanks go to @mmontes11 for their contributions
v9.5.28: mkdocs-material-9.5.28
- Fixed #7313: Improved tooltips mounted in sidebar when feature is disabled
v9.5.27: mkdocs-material-9.5.27
- Updated Estonian translations
Thanks to @Eilyre for their contributions
v9.5.26: mkdocs-material-9.5.26
- Fixed #7232: Tab switches on scroll when linking tabs (9.5.19 regression)
- Fixed #7230: Blog author avatar broken when referring to local file
v9.5.25: mkdocs-material-9.5.25
- Fixed #7209: Tags plugin crashing on numeric tags
v9.5.24: mkdocs-material-9.5.24
- Fixed #7187: Version selector title rendering issue
v9.5.23: mkdocs-material-9.5.23
- Fixed #7183: Edge case in anchor navigation when using instant navigation
- Fixed #6436: Version selector not showing version alias
v9.5.22: mkdocs-material-9.5.22
- Fixed #7170: Copy button adds empty lines for line spans (9.5.18 regression)
- Fixed #7160: Version switching doesn't stay on page (9.5.5 regression)
- Fixed #5619: Links in Mermaid.js diagrams not discernible
v9.5.21: mkdocs-material-9.5.21
- Fixed #7133: Ensure latest version of Mermaid.js is used
- Fixed #7125: Added warning for dotfiles in info plugin
Thanks to @kamilkrzyskow for their contributions
v9.5.20: mkdocs-material-9.5.20
- Fixed deprecation warning in privacy plugin (9.5.19 regression)
- Fixed #7119: Tags plugin emits deprecation warning (9.5.19 regression)
- Fixed #7118: Social plugin crashes if fonts are disabled (9.5.19 regression)
- Fixed #7085: Social plugin crashes on Windows when downloading fonts
v9.5.19: mkdocs-material-9.5.19
- Updated MkDocs to 1.6 and limited version to < 2
- Updated Docker image to latest Alpine Linux
- Removed
setup.py, now that GitHub fully understandspyproject.toml - Improved interop of social plugin with third-party MkDocs themes
- Fixed #7099: Blog reading time not rendered correctly for Japanese
- Fixed #7097: Improved resilience of tags plugin when no tags are given
- Fixed #7090: Active tab indicator in nested content tabs rendering bug
v9.5.18: mkdocs-material-9.5.18
- Refactored tooltips implementation to fix positioning issues
- Fixed #7044: Rendering glitch when hovering contributor avatar in Chrome
- Fixed #7043: Highlighted lines in code blocks cutoff on mobile
- Fixed #6910: Incorrect position of tooltip for page status in sidebar
- Fixed #6760: Incorrect position and overly long tooltip in tables
- Fixed #6488: Incorrect position and cutoff tooltip in content tabs
v9.5.17: mkdocs-material-9.5.17
- Updated Serbian translations
- Fixed #7003: Confusing keyboard interaction for palette toggle
- Fixed #7001: Blog posts now show time by default (9.5.16 regression)
- Fixed edge case in backport of social plugin font loading logic
Thanks to @stcksmsh for their contributions.
v9.5.16: mkdocs-material-9.5.16
- Updated Russian translations
- Improved error handling and reporting in social plugin
- Improved error handling and reporting in privacy plugin
- Fixed blog plugin not allowing to use time in format strings
- Fixed #6983: Social plugin crashes because of Google Fonts API change
Thanks to @kamilkrzyskow, @Guts, @szg-alex-payne and @natakazakova for their contributions
v9.5.15: mkdocs-material-9.5.15
- Reverted fix for transparent iframes (9.5.14)
- Fixed #6929: Interference of social plugin and auto dark mode
- Fixed #6938: Giscus shows dark background in light mode (9.5.14 regression)
v9.5.14: mkdocs-material-9.5.14
- Added support for hiding versions from selector when using mike
- Added init system to improve signal handling in Docker image
- Fixed edge cases in exclusion logic of info plugin
- Fixed inability to reset pipeline in search plugin
- Fixed syntax error in Finnish translations
- Fixed #6917: UTF-8 encoding problems in blog plugin on Windows
- Fixed #6889: Transparent iframes get background color
Thanks to @kamilkrzyskow, @yubiuser and @todeveni for their contributions
v9.5.13: mkdocs-material-9.5.13
- Updated Slovak translations
- Improved info plugin interop with projects plugin
- Improved info plugin inclusion/exclusion logic
- Fixed info plugin not gathering files recursively
- Fixed #6750: Ensure info plugin packs up all necessary files
Thanks to @kamilkrzyskow and @scepka for their contributions
v9.5.12: mkdocs-material-9.5.12
- Fixed #6846: Some meta tags removed on instant navigation (9.4.2 regression)
- Fixed #6823: KaTex not rendering on instant navigation (9.5.5 regression)
- Fixed #6821: Privacy plugin doesn't handle URLs with encoded characters
v9.5.11: mkdocs-material-9.5.11
- Updated Finnish translation
v9.5.10: mkdocs-material-9.5.10
- Updated Bahasa Malaysia translations
- Fixed #6783: Hide continue reading link for blog posts without separators
- Fixed #6779: Incorrect positioning of integrated table of contents
v9.5.9: mkdocs-material-9.5.9
- Fixed navigation pruning with tabs and sections enabled
v9.5.8: mkdocs-material-9.5.8
- Added Tamil translations
- Updated Esperanto translations
- Fixed relative images not being resolved for instant navigation
v9.5.7: mkdocs-material-9.5.7
- Fixed #6731: Small images in figures are not centered
- Fixed #6719: Instant navigation breaks table of contents (9.5.5 regression)
v9.5.6: mkdocs-material-9.5.6
- Fixed #6700: Missing styles for Mermaid.js labels with Markdown
v9.5.5: mkdocs-material-9.5.5
- Updated Tagalog translations
- Updated Pillow to 10.2 to mitigate security vulnerabilities
- Improved resilience of instant navigation
- Fixed #6687: Updated Mermaid.js to version 10.7.0 (latest)
- Fixed #6652: Keyboard events in custom elements captured
- Fixed #6582: Instant navigation doesn't correctly handle alternate URLs
- Fixed #6565: Instant navigation doesn't allow for
onclickhandlers - Fixed #6345: Instant navigation sometimes breaks browser back button
- Fixed #6334: Instant navigation doesn't correctly position anchors (Safari)
- Fixed #6275: Instant navigation doesn't correctly resolve after 404
- Fixed #6102: Instant navigation reloads page on same link navigation
v9.5.4: mkdocs-material-9.5.4
- Fixed #6645: Local storage with invalid value can break site
- Fixed #6635: Tags icons before default ignored if default is set
v9.5.3: mkdocs-material-9.5.3
- Limited version range of MkDocs to < 1.6
- Updated Macedonian translations
- Fixed #6520: Group plugin crashes when using mike
- Fixed #6494: Hide author's email address if disabled in git-authors plugin
v9.5.2: mkdocs-material-9.5.2
- Fixed types for
slugifysettings in blog plugin config - Fixed #6469: Horizontal scrollbars on MathJax containers
v9.5.1: mkdocs-material-9.5.1
- Updated Greek translations
- Fixed #6464: Privacy plugin cannot be enabled
- Fixed #6461: Sorting blog posts ignores time component in date
v9.5.0: mkdocs-material-9.5.0
Merged Insiders features of 'Goat's Horn' funding goal
- Added privacy plugin: automatic downloading of external assets
- Added support for card grids and grid layouts
- Added support for improved tooltips
- Added support for content tabs anchor links (deep linking)
- Added support for automatic dark/light mode
- Added support for document contributors
v9.4.14: mkdocs-material-9.4.14
- Added support for linking authors in blog posts
v9.4.13: mkdocs-material-9.4.13
- Fixed #6365: Blog plugin pagination links to previous pages broken
- Fixed #5758: Updated Mermaid.js to version 10.6.1 (latest)
v9.4.12: mkdocs-material-9.4.12
- Improved blog plugin to generate Unicode-aware slugs by default
- Fixed non-deterministic order of categories in blog plugin
v9.4.11: mkdocs-material-9.4.11
- Fixed #6364: Search plugin crashing when enabling theme while serving
- Fixed blog plugin crashing when disabling pagination
v9.4.10: mkdocs-material-9.4.10
- Fixed #6356: Version selector can't be disabled via mike's configuration
- Fixed #6281: Navigation not rendering due to Safari bug (9.4.2 regression)
- Fixed #6261: Navigation expansion animates on first load (9.4.2 regression)
v9.4.9: mkdocs-material-9.4.9
- Fixed #6344: Long entries cutoff in table of contents
- Fixed #6336: Custom template for glob archive not working with pagination
- Fixed #6328: Blog plugin crashes for locales with dashes, e.g.
pt-BR - Fixed #6327: Copy-to-clipboard button doesn't trim trailing line feed
- Fixed #6302: Version strings not matched when using mike, only aliases
- Fixed instant navigation progress indicator for gzipped content in Chrome
- Fixed rendering bug on details marker rotation in Firefox
v9.4.8: mkdocs-material-9.4.8
- Fixed invalid local address replacement when using instant loading
- Fixed #6275: Crash after navigation caused 404 when using instant loading
v9.4.7: mkdocs-material-9.4.7
- Added Azerbaijani translations
v9.4.6: mkdocs-material-9.4.6
- Updated Danish and Norwegian (Nynorsk) translations
- Fixed #6169: Blog post metadata layout overflows on small screens
v9.4.5: mkdocs-material-9.4.5
- Fixed sidebar auto-positioning (9.4.2 regression)
- Fixed #6166: Improve group plugin compatibility with Python < 3.10
- Fixed #6157: Hiding tags does not work (9.4.3 regression)
v9.4.4: mkdocs-material-9.4.4
- Added support for overriding text to be copied for code blocks
- Fixed broken layout in some browsers at breakpoints when using zoom
- Fixed #6132: Incomplete search highlighting for code blocks in titles
v9.4.3: mkdocs-material-9.4.3
- Added support for instant navigation progress indicator
- Improved spacing and alignment of tags
- Moved back-to-top button into separate partial
- Fixed #6104: Indentation for some code blocks lost in search
- Fixed #6094: Blog post metadata overlaps with footer on small screens
- Fixed #6069: Blog plugin crashes for categories with non-ASCII names
Updated templates (diff)
base.html
v9.4.2: mkdocs-material-9.4.2
- Updated Slovenian translations
- Added animation to sidebar navigation expansion and collapse
- Added support for auto-replacement of document head for instant navigation
- Improved compatibility of new emoji extension with Python < 3.10
- Switched regex dependency to use minimal version
- Refactored alignment and spacing of sidebar navigation
- Fixed expansion button not focusable via keyboard in sidebar navigation
- Fixed viewport offset restoration on first load when using instant navigation
- Fixed accidental highlight of non-clickable elements in blog plugin sidebar
- Fixed #6041: Blog plugin crashes when
navis defined and blog not included - Fixed #5972: Blog plugin ignores section index pages in paginated views
- Fixed #5954: Repeated click on anchor ignored when using instant navigation
- Fixed #5742: Keyboard navigation broken when using instant navigation
Updated templates (diff)
partials/nav-item.htmlblog-post.html
v9.4.1: mkdocs-material-9.4.1
- Improved colors and contrast in dark mode
- Improved admonition borders to match font weight
- Switched content tabs to neutral color
v9.4.0: mkdocs-material-9.4.0
- Added Belarusian translations
- Added version info to entrypoint of package
- Added emoji extension as a replacement for
materialx - Improved slate color scheme (dark mode) - now even darker
- Restructured project to improve development experience
- Updated MkDocs to 1.5.3
- Fixed #3890: Development mode crash on Linux
v9.3.2: mkdocs-material-9.3.2
- Updated Slovenian translations
- Updated Python dependencies in requirements to use minimum versions
- Fixed #6017: Code highlighting inconsistent in Community and Insiders edition
- Fixed #6001: Contributor avatars display incorrectly in Firefox
- Fixed #6000: Blog post drafts are included in navigation
v9.3.1: mkdocs-material-9.3.1
- Fixed crash of group plugin when used together with hooks
v9.3.0: mkdocs-material-9.3.0
- Improved configuration sharing between community and Insiders edition
- Added experimental built-in group plugin for enabling plugins conditionally
- Added new settings in tags plugin for enabling/disabling
- Dropped support for Python 3.7 (EOL)
v9.2.8: mkdocs-material-9.2.8
- Updated Italian and Russian translations
- Fixed #5952: Combining blog and tags plugin leads to wrong links
- Fixed #5951: Blog plugin ignores post title in metadata
- Fixed #5949: Blog plugin ignores post linked in nav
v9.2.7: mkdocs-material-9.2.7
- Switched dependencies to compatible release clauses
- Removed
readtimeandlxmldependencies for blog plugin - Reduced size of Docker image to improve CI build performance
- Fixed #5945: Incorrect footer navigation for sibling pages of blog
- Fixed #5939: Page jumps when changing color palette (Firefox 117)
- Fixed #5901: Announcement bar reappears when using instant loading
- Fixed #5824: Allow to customize styles of sequence diagrams
v9.2.6: mkdocs-material-9.2.6
- Added Basque translations
- Added template for simple redirects
- Improved blog plugin interop by moving view generation to
on_files - Fixed #5924: Social plugin still checks dependencies when disabled
- Fixed #5916: Blog plugin crashes on Python 3.8 (9.2.0 regression)
v9.2.5: mkdocs-material-9.2.5
- Fixed error in dirty serve mode when using blog plugin
- Fixed page title not being consistent in blog plugin pagination
- Fixed #5899: Blog plugin pagination breaks when disabling directory URLs
v9.2.4: mkdocs-material-9.2.4
- Added version to bug report name in info plugin
- Updated Afrikaans translations
v9.2.3: mkdocs-material-9.2.3
- Fixed blog plugin rendering wrongly with
markdown.extensions.toc - Fixed blog plugin entrypoint generation
v9.2.2: mkdocs-material-9.2.2
- Fixed #5880: Blog plugin failing when building a standalone blog
- Fixed #5881: Blog plugin not compatible with Python < 3.10
v9.2.1: mkdocs-material-9.2.1
- Fixed #5879: Blog plugin failing when building a standalone blog
- Fixed error in blog plugin when using draft tagging on future date
- Fixed error in blog plugin when toc extension is not enabled
v9.2.0: mkdocs-material-9.2.0
Additions and improvements
- Added blogging support via built-in blog plugin
- Added support for Chinese language segmentaiton in search plugin
- Added support for adding custom dates to blog posts
- Added support for paginating archive and category pages
- Added support for annotations (outside of code blocks)
- Added support for navigation icons
- Added support for navigation pruning
- Added support for navigation status
- Added support for customizing site icons
- Added support for customizing (code) annotation icons
- Added focus outline to admonitions and details
- Added prompt for bug report name to info plugin
- Added Luxembourgish translations
- Improved rendering of (code) annotation markers
- Improved print styles for (code) annotations
- Improved customizability of navigation tabs
- Improved interop of plugins with external tools like mike
- Improved interop of blog plugin with awesome pages plugin
- Improved header partial by moving buttons into separate partials
- Improved clarity of
site_urlwarning in social plugin - Improved blog plugin to automatically setup directory structure
- Switched info plugin to
importlibto mitigate deprecations - Automatically download ResizeObserver polyfill when necessary
- Automatically add iframe-worker polyfill when necessary in offline plugin
- Automatically focus and bring up keyboard on touch devices
- Updated Serbo-Croatian translations
- Updated MkDocs to 1.5.2
Removals
- Removed Universal Analytics integration
- Removed ancient polyfills to reduce size of bundled JavaScript by 20%
- Removed necessity for
Array.flatandArray.flatMappolyfill - Removed announcement bar button when JavaScript is not available
Fixes
- Fixed rendering of tags when announcement bar is present
- Fixed tags plugin rendering pages excluded by other plugins
- Fixed #5132: Blog plugin requires
naventry inmkdocs.yml - Fixed #5599: Insufficient contrast for default link color
- Fixed #5715: Blog plugin missing integrated table of contents in pagination
- Fixed #5806: Version selector not hoverable on some Android devices
- Fixed #5826: Blog post drafts with tags show up in tags index
v9.1.21: mkdocs-material-9.1.21
- Fixed MkDocs 1.4 compat issue in social plugin (9.1.20 regression)
v9.1.20: mkdocs-material-9.1.20
- Updated Sanskrit translations
- Fixed deprecation warnings for social plugin
v9.1.19: mkdocs-material-9.1.19
- Added support for MkDocs 1.5+
- Fixed #5699: Improve error reporting in social plugin
v9.1.18: mkdocs-material-9.1.18
- Updated Danish translations
- Added support for installing user requirements in Docker image
- Fixed #5655: Search separator with lookbehind breaks highlighting
v9.1.17: mkdocs-material-9.1.17
- Fixed #5633: Code annotations with nested lists incorrectly mounted
- Fixed #5628: Regression in new social plugin configuration scheme
v9.1.16: mkdocs-material-9.1.16
- Updated Indonesian translations
- Ensure scroll bar follows color scheme of operating system
v9.1.15: mkdocs-material-9.1.15
- Fixed #5566: Indicate color scheme to operating system
- Fixed #5565: Update
Dockerfileto latest version of base image - Fixed #5554: Add additional version tags (
9,9.1) to Docker image - Fixed #5536: Strip tags of ARIA labels in table of contents
v9.1.14: mkdocs-material-9.1.14
- Updated Armenian and Greek translations
v9.1.13: mkdocs-material-9.1.13
- Fixed #5517: Social plugin crashes for some fonts (e.g. Open Sans)
v9.1.12: mkdocs-material-9.1.12
- Updated Bengali (Bangla) translations
- Fixed #5503: Docker image publish errors on uppercase characters
- Fixed #5407: Auto-pause media when in hidden content tabs
v9.1.11: mkdocs-material-9.1.11
- Fixed #5487: Social plugin crashes without options (9.1.10 regression)
v9.1.10: mkdocs-material-9.1.10
- Added
cards_layout_optionssetting for social cards - Deprecated
cards_colorandcards_fontsetting for social cards
v9.1.9: mkdocs-material-9.1.9
- Added Telugu, Kannada and Sanskrit translations
- Fixed #5428: Fixed margins for light/dark mode images in figures
- Fixed #5420: Social plugin crashing for some specific Google Fonts
- Fixed #5160: Instant loading makes code annotations jump (9.1.1 regression)
- Fixed #4920: Social plugin not loading logo from custom icon set
- Fixed social plugin crashing when only code font is specified
v9.1.8: mkdocs-material-9.1.8
- Fixed #5417: Theme breaks when
paletteis not defined (9.1.7 regression)
v9.1.7: mkdocs-material-9.1.7
- Updated Persian (Farsi) and Turkish translations
- Fixed #5401: Added missing flag to disable built-in tags plugin
- Fixed #5206: Ensure defaults are set for primary and accent colors
- Fixed unnecessary inclusion of palette CSS when unused
v9.1.6: mkdocs-material-9.1.6
- Updated Persian (Farsi) translations
- Fixed #5300: Boxes in Mermaid sequence diagrams not color-abiding
v9.1.5: mkdocs-material-9.1.5
- Updated Lithuanian and Japanese translations
- Updated Mermaid.js to version 9.4.3
- Fixed #5290: Footer previous/next labels cut-off for short page titles
v9.1.4: mkdocs-material-9.1.4
- Fixed #5239: Instant loading breaks anchors in details (9.1.1 regression)
- Fixed #5211: Anchor following not working for Chinese (9.1.2 regression)
v9.1.3: mkdocs-material-9.1.3
- Added Kurdish (Soranî) translations
- Updated Norwegian (Bokmål), Portuguese and Romanian translations
- Improved compatibility with
mkdocs-jupyterplugin - Fixed #5198: Built-in search plugin not filtering
scriptandstyletags - Fixed #5176: Back-to-top + instant loading not working (9.1.1 regression)
v9.1.2: mkdocs-material-9.1.2
- Updated Icelandic, Korean and Swedish translations
- Fixed #5168: Mermaid text boxes overflow (9.0.13 regression)
- Fixed #5155: table of contents not highlighting percent-encoded URLs
v9.1.1: mkdocs-material-9.1.1
- Updated Czech and Thai translations
- Improved instant loading (scroll restoration, slow connections)
- Fixed #5023: Instant loading not allowing to go back to initial page
- Fixed #3797: Instant loading does not work with section anchors in Safari
v9.1.0: mkdocs-material-9.1.0
- Docker image now available for
amd64,arm64andarm/v7 - Updated Chinese (Taiwanese) translations
- Generalized tag identifier implementation
- Fixed flickering of header shadow on load
- Fixed occasional flickering of announcement bar
v9.0.15: mkdocs-material-9.0.15
- Updated Chinese (Traditional) translations
- Updated Hebrew translations
v9.0.14: mkdocs-material-9.0.14
- Fixed #5072: Rendering bug on navigation expand button in Firefox
v9.0.13: mkdocs-material-9.0.13
- Updated Uzbek translations
- Switched back to pre-9.0.0 headline detection in
contentpartial - Fixed #5062: Version warning not readable when using slate scheme
- Fixed #5061: Improved discernibility of table row hover color
- Fixed #5034: Sequence actors in Mermaid diagrams not color-abiding
- Fixed #4919: Allow to hide version warning in multiple versions
v9.0.12: mkdocs-material-9.0.12
- Updated Catalan translations
- Fixed #4975: Mermaid entity relationship rendering diagrams bug
- Fixed #4924: Header title not reset when using instant loading
v9.0.11: mkdocs-material-9.0.11
- Added Mastodon verification for social links (
rel=me) - Updated Italian translations
v9.0.10: mkdocs-material-9.0.10
- Updated Arabic translations
- Updated Korean translations
- Updated Hungarian translations
- Updated Russian translations
- Fixed #4977: Improved accessibility for content tabs
- Fixed #4960: Sometimes anchor following doesn't bring last item into view
v9.0.9: mkdocs-material-9.0.9
- Updated Bulgarian translations
- Updated Chinese (Simplified) translations
- Updated Dutch translations
- Updated Hindi translations
- Updated Japanese translations
- Updated Polish translations
v9.0.8: mkdocs-material-9.0.8
- Updated Croatian translations
- Updated French translations
- Updated Hungarian translations
- Updated Portuguese (Brasilian) translations
- Updated Spanish translations
- Updated Ukrainian translations
- Updated Urdu translations
- Updated Vietnamese translations
v9.0.7: mkdocs-material-9.0.7
- Improved accessibility of sidebar navigation
- Moved all translations into community edition
- Updated Polish and Portuguese (Brasilian) translations
- Fixed info plugin terminating on subsequent reload when serving
- Fixed #4910: Sidebar navigation labels have invalid ARIA roles
- Fixed #4884: Search query terms can't be separated by colons
v9.0.6: mkdocs-material-9.0.6
- Fixed #4883: Automatically disable info plugin when serving
- Fixed #4885: Search plugin crashes in some exotic cases (9.0.3 regression)
v9.0.5: mkdocs-material-9.0.5
- Fixed #4842: Improved accessibility of search result list
v9.0.4: mkdocs-material-9.0.4
- Fixed #4823: Improved contrast ratio in footer (9.0.2 regression)
- Fixed #4832: Set navigation items back to black (9.0.3 regression)
- Fixed #4843: Emojis broken due to
maxcdn.comshutting down - Upgraded Python Markdown Extensions to 9.9.1
v9.0.3: mkdocs-material-9.0.3
- Improved discernability of section index pages in navigation
- Improved collapsing of adjacent whitespace in search plugin
- Updated Indonesian translations
- Fixed view source of this page button when edit URL points to blob
- Fixed #4829: Search overlay does not close for active anchor result
- Fixed #4824: Search plugin crashes for
h[1-6]contained in other elements - Fixed #4804: Nested navigation items not expandable with keyboard
- Fixed #4689: anchor tracking not working for anchors in tables
- Upgraded to Mermaid 9.3.0
v9.0.2: mkdocs-material-9.0.2
- Fixed #4823: Improved contrast ratio in footer to meet WCAG guidelines
- Fixed #4819: Social plugin crashes when card generation is disabled
- Fixed #4817: Search plugin crashes on numeric page titles in
nav
v9.0.1: mkdocs-material-9.0.1
- Removed
pipdeptreedependency for built-in info plugin - Fixed appearance of linked tags when hovered (9.0.0 regression)
- Fixed #4810: Abbreviations run out of screen on touch devices
- Fixed #4813: View source and edit button links are the same
v9.0.0: mkdocs-material-9.0.0
Additions and improvements
- Added support for rich search previews
- Added support for tokenizer lookahead
- Added support for better search highlighting
- Added support for excluding content from search
- Added support for configurable search pipeline
- Added support for offline search via offline plugin
- Added support for multiple instances of built-in tags plugin
- Added support for removing copy-to-clipboard button
- Added support for removing footer navigation
- Added support for button to view the source of a page
- Improved readability of query string for search sharing
- Improved stability of search plugin when using
--dirtyreload - Improved search result group button, now sticky and stable
- Updated Norwegian translations
- Updated MkDocs to 1.4.2
Removals
- Removed deprecated alternative admonition qualifiers
- Removed
:is()selectors (in output) for easier overriding - Removed
.titlesuffix on translations - Removed legacy method for providing page title in feedback URL
- Removed support for indexing only titles in search
- Removed support for custom search transforms
- Removed support for custom search workers
- Removed temporary snow feature (easter egg)
Fixes
- Fixed Norwegian and Korean language code
- Fixed detection of composition events in search interface
- Fixed search plugin not using title set via front matter
- Fixed search highlighting of tags
- Fixed search sharing URL using post transformed string
- Fixed theme-color meta tag getting out-of-sync with palette toggle
- Fixed prev/next page keyboard navigation when footer is not present
- Fixed overflowing navigation tabs not being scrollable
- Fixed inclusion of code block line numbers from search
v8.5.11: mkdocs-material-8.5.11
- Let it snow, see https://twitter.com/squidfunk/status/1597939243090788352
v8.5.10: mkdocs-material-8.5.10
- Adjusted CSS to better allow for custom primary and accent colors
- Fixed #4620: Primary color is not applied (8.5.9 regression)
v8.5.9: mkdocs-material-8.5.9
- Fixed #4600: Illegible links for black/white primary colors (8.5.8 regression)
- Fixed #4594: Need to set schema to change link color
v8.5.8: mkdocs-material-8.5.8
- Added support for always showing settings in cookie consent
- Fixed #4571: Buttons invisible if primary color is
whiteorblack - Fixed #4517: Illegible note in sequence diagram when using
slatescheme
v8.5.7: mkdocs-material-8.5.7
- Deprecated additional admonition qualifiers to reduce size of CSS
- Fixed #4511: Search boost does not apply to sections
v8.5.6: mkdocs-material-8.5.6
- Modernized appearance of admonitions (with fallback, see docs)
- Improved appearance of inline code blocks in admonition titles
v8.5.5: mkdocs-material-8.5.5
- Updated MkDocs to 1.4
- Fixed compatibility issues with MkDocs 1.4
- Fixed #4430: build error when enabling consent without repository URL
v8.5.4: mkdocs-material-8.5.4
- Fixed expand icons shift on sidebar overflow (using
scrollbar-gutter) - Fixed #4429: Text in sequence diagrams overflows in Firefox
v8.5.3: mkdocs-material-8.5.3
- Fixed build error when enabling cookie consent without analytics
- Fixed #4381: Code blocks render ligatures for some fonts
v8.5.2: mkdocs-material-8.5.2
- Updated Mermaid.js to version 9.1.7
- Fixed overly large headlines in search results (8.5.0 regression)
- Fixed #4358: Navigation sections appear as clickable (8.5.0 regression)
- Fixed #4356: GitHub repository statistics fetched before consent
v8.5.1: mkdocs-material-8.5.1
- Fixed #4366: Removed dependencies with native extensions
v8.5.0: mkdocs-material-8.5.0
- Added support for social cards
- Added support for code annotation anchor links (deep linking)
- Added support for code annotation comment stripping (syntax modifier)
- Added support for sidebars scrolling automatically to active item
- Added support for anchor following table of contents (= auto scroll)
- Added support for tag icons
v8.4.4: mkdocs-material-8.4.4
- Moved comments integration to separate partial (
comments.html)
v8.4.3: mkdocs-material-8.4.3
- Added Simple Icons to bundled icons (+2,300 icons)
- Added support for changing edit icon
- Moved page actions to separate partial (
actions.html) - Fixed #4291: Version switching doesn't stay on page when anchors are used
- Fixed #4327: Links in data tables do not receive link styling
v8.4.2: mkdocs-material-8.4.2
- Updated Slovenian translations
- Fixed #4277: Feedback widget hidden after navigation with instant loading
- Fixed numeric tags in front matter breaking search functionality
v8.4.1: mkdocs-material-8.4.1
- Updated Croatian and Hebrew translations
v8.4.0: mkdocs-material-8.4.0
- Added support for cookie consent
- Added support for feedback widget (Was this page helpful?)
- Added support for dismissable announcement bar
- Added Armenian, Lithuanian, Tagalog, and Urdu translations
v8.3.9: mkdocs-material-8.3.9
- Updated Taiwanese translations for search
- Allow ids for content tabs with special characters (for mkdocstrings)
- Fixed #4083: home not clickable when using versioning (8.3.5 regression)
v8.3.8: mkdocs-material-8.3.8
- Fixed #4053: Limit width of videos to content area
- Fixed empty tags in front matter breaking search
v8.3.7: mkdocs-material-8.3.7
- Fixed search being stuck initializing when using tags (8.3.4 regression)
v8.3.6: mkdocs-material-8.3.6
- Fixed #4028: Links not clickable when using versioning (8.3.5 regression)
v8.3.5: mkdocs-material-8.3.5
- Fixed #4012: Stay on page not working for alias of active version
v8.3.4: mkdocs-material-8.3.4
- Fixed #4004: Tags with multiple words not searchable
v8.3.3: mkdocs-material-8.3.3
- Fixed #4000: Mermaid diagrams too dark in dark mode (8.3.0 regression)
v8.3.2: mkdocs-material-8.3.2
- Fixed #3987: Custom admonition icons don't work when defining color palette
v8.3.1: mkdocs-material-8.3.1
- Bump required Jinja version to 3.0.2
- Removed unnecessary conditions in templates
- Fixed scroll offset when content tabs are brought into view
- Fixed #3977: Content tabs snapping oddly in Firefox
- Fixed #3983: Missing condition in footer partial (8.3.0 regression)
v8.3.0: mkdocs-material-8.3.0
- Added support for custom admonition icons
- Added support for linking of content tabs
- Added support for boosting pages in search
- Added support for hiding footer navigation
- Added previous/next indicators to content tabs
- Improved typeset link colors in light and dark modes
v8.2.16: mkdocs-material-8.2.16
- Fixed #3957: Only animate code annotations when visible (save CPU cycles)
v8.2.15: mkdocs-material-8.2.15
- Added Uzbek translations
- Fixed spacing for code block results in content tabs
v8.2.14: mkdocs-material-8.2.14
- Fixed missing top right rounded border on admonition
- Fixed #3886:
4xxstatus codes not handled when using instant loading
v8.2.13: mkdocs-material-8.2.13
- Fixed #3865: Tags index links to tagged pages 404 on Windows
- Fixed #3866: Bump required Python version from 3.6+ to 3.7+
v8.2.12: mkdocs-material-8.2.12
- Added support for GitHub-style hash fragments for dark/light images
- Improved rendering of nested code blocks in content tabs and annotations
- Fixed #3862: Upgraded to latest Pygments and Python Markdown Extensions
v8.2.11: mkdocs-material-8.2.11
- Temporarily pinned Pygments to <2.12
- Temporarily pinned Python Markdown Extensions to <9.4
- Improved rendering of code annotation markers
v8.2.10: mkdocs-material-8.2.10
- Added Macedonian translations
- Updated Mermaid.js to version 9.0.1
- Switched sidebar title in mobile navigation to bold font
- Fixed color of arrows in class and state diagrams for dark mode
- Fixed #3836: Inline admonitions overlayed by code block titles
v8.2.9: mkdocs-material-8.2.9
- Mitigate flicker on color palette switch by disabling all transitions
- Fixed search suggestions not triggered when following deep link
- Fixed incorrectly computed header height when using instant loading
- Fixed #3782: Admonition titles have extra pixels on wide screens in Firefox
- Fixed #3802: Always render table of contents container (except when hidden)
v8.2.8: mkdocs-material-8.2.8
- Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja
- Reverted Jinja version range limitation (added in 8.2.7)
- Improved styling of annotations and fixed borders of code blocks in tabs
- Added background color to code blocks in focused/hovered links
- Added check in tags plugin whether tags overview page exists
- Fixed #3744: Content tab indicator on wrong position when using back button
v8.2.7: mkdocs-material-8.2.7
- Temporarily limit Jinja version range to < 3.1 due to breaking changes (see mkdocs/mkdocs#2794)
v8.2.6: mkdocs-material-8.2.6
- Fixed #3695: Deprecation warning for unescaped backslashes in templates
- Fixed #3696: Annotations not mounted in some Terraform code blocks
- Fixed #3698: Annotations not mounted in long code blocks (8.2.5 regression)
v8.2.5: mkdocs-material-8.2.5
- Fixed #3596: Mermaid not working when headline with name 'Mermaid' present
- Fixed #3643: Reduce time to render pages with thousands of code blocks
- Fixed #3665: Missing styles for Mermaid.js flowcharts cluster labels
v8.2.4: mkdocs-material-8.2.4
- Fixed malformed Google Fonts URL when a font setting was omitted
- Fixed #3648: Fixed specificity issue with admonitions in lists
- Fixed #3653: Invalid outdated version banner URL when using instant loading
v8.2.3: mkdocs-material-8.2.3
- Fixed #3578: Active element in table of contents off-by-one on large screens
v8.2.2: mkdocs-material-8.2.2
- Added automatic removal of query parameter when search is closed
- Fixed #3599: Anchors always overriden when using navigation tracking
v8.2.1: mkdocs-material-8.2.1
- Fixed module
material.pluginsnot being found (8.2.0 regression)
v8.2.0: mkdocs-material-8.2.0
- Added native support for Mermaid.js diagrams
- Added native support for tags (with search integration)
- Added support for staying on page when switching versions
v8.1.11: mkdocs-material-8.1.11
- Added Portuguese (Brasilian) translations
- Updated FontAwesome to v6 – check which icons were renamed here
- Fixed #3545: Color palette toggle and search overlaying version selector
v8.1.10: mkdocs-material-8.1.10
- Fixed cutoff of very wide logos in the sidebar on mobile
v8.1.9: mkdocs-material-8.1.9
- Added support for
mkdocs.ymlvalidation and auto-complete - Fixed errors in Latvian translations
v8.1.8: mkdocs-material-8.1.8
- Added Latvian translations
- Updated Giscus example integration with dynamic theme change support
- Fixed #3479: Back-to-top button not hidden when using sticky navigation tabs
- Fixed #3491: Logo in header and drawer doesn't honor aspect ratio
v8.1.7: mkdocs-material-8.1.7
- Improved back-to-top button behavior - now not shown on anchor jump
v8.1.6: mkdocs-material-8.1.6
- Fixed spacing of blockquotes (8.1.5 regression)
- Fixed edge cases for rounded corners on code blocks (8.1.5 regression)
- Fixed issues with code annotation line heights
v8.1.5: mkdocs-material-8.1.5
- Improved browser support: Chrome 49+, Safari 10+, Firefox 53+, Edge 79+
- Improved rendering of inline code blocks in headlines
- Added Bahasa Malaysian translations
- Fixed #3354: MathJax formulas show vertical scrollbar
v8.1.4: mkdocs-material-8.1.4
- Added indicator to navigation expander icon
- Improved support for reduced motion preference
- Fixed jitter of active content tab indicator
v8.1.3: mkdocs-material-8.1.3
- Added animation to active content tab indicator
- Fixed #3360: Highlighted lines add blank lines in copied text
- Fixed usage of subsequent index files when using section index pages
v8.1.2: mkdocs-material-8.1.2
- Switched CSS sources to logical properties
- Added transformation of logical properties to
ltr/rtlequivalents - Fixed spacing for admonitions inside lists (8.1.1 regression)
v8.1.1: mkdocs-material-8.1.1
- Added support for
#only-lightand#only-darkimage hash fragments - Fixed copy-to-clipboard adding blank lines when using line anchors
- Fixed code annotation directionality for right-to-left languages
- Fixed header title positioning for right-to-left languages
- Fixed admonition borders for right-to-left languages (8.0.0 regression)
- Fixed footer navigation link positioning (8.0.0 regression)
- Fixed footer navigation title breaking out of container when too long
- Fixed shrinking arrow in navigation title when too long
- Fixed #3343: Filtered stopwords appear as missing search terms
- Fixed #3346: Site unusable due to usage of
:not()(Firefox 78 ESR)
v8.1.0: mkdocs-material-8.1.0
- Added basic support for code block line anchors
- Switched code annotation markers to
+signs to improve usability - Switched main site title to bold font
- Improved admonition icon positioning to align when
font-sizeis increased - Improved and simplified footnotes CSS
- Improved and simplified code annotation positioning
- Fixed syntax error in Russian translations
v8.0.5: mkdocs-material-8.0.5
- Fixed #3302: Footer refactoring induced ellipsis in some browsers
- Fixed #3313: Details always rendered closed on load (8.0.4 regression)
v8.0.4: mkdocs-material-8.0.4
- Improved support for deeply nested code annotations
- Improved code annotation and copy-to-clipboard interop
- Improved styling for code annotations inside admonitions
- Fixed #3294: Lists after code blocks without code annotations disappearing
- Fixed #3274: Invalid anchor positioning when using instant loading
- Fixed several positioning issues for code annotations
- Fixed JavaScript source map roots
v8.0.3: mkdocs-material-8.0.3
- Removed deprecated
google_analyticssetting (was forgotten in 8.0.0) - Fixed syntax error in Swedish and Polish translations
- Fixed #3283: Invalid back-to-top button position with sticky navigation tabs
- Fixed #3285: Default details marker showing due to Safari bug
v8.0.2: mkdocs-material-8.0.2
- Fixed #3275: Code annotations always disappear on click
v8.0.1: mkdocs-material-8.0.1
- Improved rendering of code annotation markers
- Fixed #3265: Wrong margin on nested admonitions
- Fixed wrong
box-sizingfor code annotations in details
v8.0.0: mkdocs-material-8.0.0
- Added support for code annotations
- Added support for anchor tracking
- Added support for version warning
- Added
copyrightpartial for easier override - Removed deprecated content tabs legacy implementation
- Removed deprecated
seealsoadmonition type - Removed deprecated
site_keywordssetting (unsupported by MkDocs) - Removed deprecated prebuilt search index support
- Removed deprecated web app manifest – use customization
- Removed
extracopyrightvariable – use newcopyrightpartial - Removed Disqus integation – use customization
- Switched to
:is()selectors for simple selector lists - Switched autoprefixer from
last 4 yearstolast 2 years - Improved CSS overall to match modern standards
- Improved CSS variable semantics for fonts
- Improved extensibility by restructuring partials
- Improved handling of
detailswhen printing - Improved keyboard navigation for footnotes
- Fixed #3214: Search highlighting breaks site when empty
Please see the upgrade guide
v7.3.6: mkdocs-material-7.3.6
- Added support for adding titles to code blocks
v7.3.5: mkdocs-material-7.3.5
- Added support for setting table of contents title via
mkdocs.yml - Fixed back-to-top button position for right-to-left languages
v7.3.4: mkdocs-material-7.3.4
- Bumped MkDocs version to 1.2.3 to mitigate CVE-2021-40978
- Fixed spacing issues when using integrate table of contents with tabs
- Fixed some spacings issues for right-to-left languages
- Fixed race condition in search initialization
v7.3.3: mkdocs-material-7.3.3
- Rewrite of entire documentation
- Adjusted height of new content tabs to match single line code blocks
- Fixed new content tabs missing right padding in some browsers on overflow
- Fixed new content tabs bleeding out of flex container on overflow
- Fixed new content tabs overflow scrolling bugs on some browsers
- Fixed new content tabs stealing keyboard access when active
- Fixed some spacings issues for right-to-left languages
v7.3.2: mkdocs-material-7.3.2
- Deprecated prebuilding of search index
- Improved graceful handling of broken search for
file:// - Added minimum Jinja version to list of requirements
- Fixed #3071: section index pages render empty directories
- Fixed margin issues when using navigation tabs (7.3.1 regression)
- Fixed search placeholder sometimes being shown too early
v7.3.1: mkdocs-material-7.3.1
- Added new experimental content tabs implementation
- Fixed #3069: GitHub stats broken for users/orgs (7.1.0 regression)
- Fixed #3070: Sections not linking to index page
- Fixed title not linking to index page when using tabs
- Fixed Disqus integration when using instant loading
- Fixed some spacing issues for right-to-left languages
- Fixed syntax error in Serbian translations
v7.3.0: mkdocs-material-7.3.0
- Added support for sticky navigation tabs
- Added support for section index pages
- Added support for removing generator notice
v7.2.8: mkdocs-material-7.2.8
- Fixed #3039: Search modal overlays menu on mobile (7.2.7 regression)
v7.2.7: mkdocs-material-7.2.7
- Updated Serbian and Serbo-Croatian translations
- Improved appearance of outline on details
- Fixed #2934: Scrollbar when header is hidden on some mobile browsers
- Fixed #3032: Anchor in details doesn't open on load (7.0.0 regression)
- Fixed back-to-top button being focusable when invisible
- Fixed broken admonition icons (removed in upstream)
v7.2.6: mkdocs-material-7.2.6
- Fixed rendering of
blockquoteelements (7.0.0 regression) - Fixed #2973: Custom search worker setting ignored
v7.2.5: mkdocs-material-7.2.5
- Updated Portuguese translations
- Fixed execution of RxJS teardown logic (7.2.3 regression)
- Fixed #2970: Search results show escaped characters (7.2.2 regression)
v7.2.4: mkdocs-material-7.2.4
- Fixed #2926: Version selector not working (7.2.3 regression)
- Fixed #2929: Missing CSS class for banner (consistency with Insiders)
v7.2.3: mkdocs-material-7.2.3
- Slight facelift of data tables, now closer to Material Design
- Fixed instant loading not respecting clicks on search results
- Fixed #2881: Invalid anchor offsets when using instant loading
v7.2.2: mkdocs-material-7.2.2
- Updated Korean translations
- Fixed #2879: Search highlighting does not properly escape HTML
v7.2.1: mkdocs-material-7.2.1
- Fixed #2862: Back-to-top button overlays active search bar
v7.2.0: mkdocs-material-7.2.0
- Added support for search suggestions to save keystrokes
- Added support for search highlighting
- Added support for search sharing (i.e. deep linking)
v7.1.11: mkdocs-material-7.1.11
- Updated Spanish and Galician translations
v7.1.10: mkdocs-material-7.1.10
- Refactored appearance of back-to-top button
- Fixed graceful handling of search when browsing locally
v7.1.9: mkdocs-material-7.1.9
- Improved search language support for Thai and Hindi
- Fixed #2761: License comments lined up at end of file
v7.1.8: mkdocs-material-7.1.8
- Refactored analytics integration (because of MkDocs 1.2)
- Added support for Google Analytics 4 (
gtag.js) - Fixed missing escape for
aria-labelin footer links
v7.1.7: mkdocs-material-7.1.7
- Improved screen reader support
v7.1.6: mkdocs-material-7.1.6
- Deprecated
seealsoadmonition qualifier - Added Mongolian and updated Chinese translations
- Fixed #2429: Version selector not touch-friendly on Android devices
- Fixed #2703: Printed 'Initializing search' albeit ready on mobile
v7.1.5: mkdocs-material-7.1.5
- Fixed #2655: Details breaking page margins on print
v7.1.4: mkdocs-material-7.1.4
- Added support for git-revision-date-localized plugin creation date
- Improved footnote styles on
:targetand:focus
v7.1.3: mkdocs-material-7.1.3
- Fixed #2586: Empty table of contents shown (7.1.2 regression)
v7.1.2: mkdocs-material-7.1.2
- Fixed #2554: List markers sometimes overlap floated elements
- Fixed #2563: Adding a class to a
h1breaks the table of contents - Fixed #2566: Back-to-top button clickable when invisible
v7.1.1: mkdocs-material-7.1.1
- Fixed #2501: Nested definition lists compound bottom margin
- Fixed #2508: Switch
extracopyrightblock to template variable - Fixed #2533: Search (and other parts) not working in Safari <14
- Fixed #2538: Visual quirk when opening language selector
v7.1.0: mkdocs-material-7.1.0
- Added support for back-to-top button
- Added support for color palette toggle
- Added latest release to repository info (GitHub)
- Slight facelift of repository info (lighter fonts, spacing and icons)
v7.0.7: mkdocs-material-7.0.7
- Updated Hungarian translations
- Fixed #2466: Docker image not based on latest Python and Alpine
- Fixed #2488: Inconsistent header shadow behavior
- Fixed #2492: Inline code blocks in admonition titles missing background
v7.0.6: mkdocs-material-7.0.6
- Added trailing slash to version selector URL
- Added support for out-of-order anchors in table of contents
- Added
extra.homepageoption to link logo to arbitrary URL - Improved security of Docker image (always update apk)
- Fixed horizontal spacing for nested inline admonitions
- Fixed text color of nested code blocks inside links
- Fixed version selector to always use version title
- Fixed logo link when using versioning with instant loading
v7.0.5: mkdocs-material-7.0.5
- Added
extracopyrightblock to allow for custom copyright info - Fixed evaluation of third-party scripts when using instant loading
- Fixed edge cases when using instant loading without directory URLs
- Fixed handling of version selector when using instant loading
- Fixed regression with header title not being updated correctly
- Fixed expanded sections not opening on first click (7.0.4 regression)
v7.0.4: mkdocs-material-7.0.4
- Added Islandic translations
- Fixed #2386: Section close requires two clicks (navigation expansion)
- Fixed console error when search is disabled (7.0.0 regression)
- Fixed localsearch integration (7.0.0 regression)
v7.0.3: mkdocs-material-7.0.3
- Fixed JavaScript errors in older browsers (target ES2020 -> ES2015)
v7.0.2: mkdocs-material-7.0.2
- Fixed #2343: Invalid source map URLs for JS and CSS files
- Fixed #2347: Version selector missing when using versioning
v7.0.1: mkdocs-material-7.0.1
- Fixed #2334: Google Analytics triggers page view twice (7.0.0 regression)
- Fixed #2336: Details bleed into inline admonitions
- Fixed #2337: Images don't align correctly (7.0.0 regression)
v7.0.0: mkdocs-material-7.0.0
- Added support for deploying multiple versions
- Added support for integrating a language selector
- Added support for rendering admonitions as inline blocks
- Rewrite of the underlying reactive architecture
- Removed Webpack in favor of reactive build strategy (-480 dependencies)
- Fixed keyboard navigation for code blocks after content tabs switch
v6.2.8: mkdocs-material-6.2.8
- Updated Japanese and Polish translations
- Fixed #2261: Print dialog auto-closing when using instant loading
v6.2.7: mkdocs-material-6.2.7
- Fixed #2251: Updated Docker image to latest Alpine Linux
v6.2.6: mkdocs-material-6.2.6
- Added Bulgarian translations
- Fixed #2233: Search not shown when using header autohiding
v6.2.5: mkdocs-material-6.2.5
- Fixed syntax error in Swedish translations
- Optimized navigation partials to improve build speed for huge docs
v6.2.4: mkdocs-material-6.2.4
- Fixed #2156: Missing syntax highlighting for binary numbers
- Fixed #2186: Disqus showing on 404 page
v6.2.3: mkdocs-material-6.2.3
- Added back hidden overflow on root container
- Fixed #2142: MathJax formulas sometimes have vertical scrollbars
v6.2.2: mkdocs-material-6.2.2
- Removed Markdown version range limit (6.2.0 regression)
v6.2.1: mkdocs-material-6.2.1
- Fixed all import and asset paths in templates (6.2.0 regression)
- Downgraded webpack-asset-manifest-plugin - broke all asset paths
v6.2.0: mkdocs-material-6.2.0
- Added support for navigation sections
- Added support for navigation expansion
- Added support for integrating table of contents into navigation
- Added support for auto-hiding header on scroll
- Added support for hiding navigation and table of contents per page
- Added support for arbitrary items in navigation tabs
- Refactored navigation tabs to simplify grouping behavior
- Fixed anchor offset for permalinks in Safari (partial revert)
- Fixed #2098: Active tab sometimes not highlighted correctly
- Improved appearance for horizontal rulers
- Improved Spanish and Swedish translations
v6.1.7: mkdocs-material-6.1.7
- Fixed #2081: Fixed stats for private GitHub repositories
- Fixed alignment for admonition icon alignment for right-to-left languages
v6.1.6: mkdocs-material-6.1.6
- Fixed #2048: Math formulas show scrollbars (Windows)
v6.1.5: mkdocs-material-6.1.5
- Fixed search reset button not showing/hiding correctly
v6.1.4: mkdocs-material-6.1.4
- Fixed sidebar jitter when scrolling footer into view
v6.1.3: mkdocs-material-6.1.3
- Added support for keywords
metatag - Fixed #2027: Line numbers don't scale with smaller font size
- Fixed link colors for black and white on
slatecolor scheme - Removed focus outline on scrolling code blocks for pointer devices
v6.1.2: mkdocs-material-6.1.2
- Fixed sizing of icons in Admonition, Tasklist, etc. (6.1.1 regression)
v6.1.1: mkdocs-material-6.1.1
- Fixed #2019: Page title not correctly updated when using instant loading
v6.1.0: mkdocs-material-6.1.0
- Fixed #1973: Added support for printing in dark mode
- Fixed #1974: Added support for printing content tabs
- Fixed #1995: Improved customizability of details extension
v6.0.2: mkdocs-material-6.0.2
- Added Georgian translations
- Added escaping for link
titleattributes where necessary - Fixed #1956: Pages with whitespace in names have invalid links in search
- Removed unnecessary (duplicated) link
titleattributes
v6.0.1: mkdocs-material-6.0.1
- Fixed stemmer support for
file://protocol throughiframe-worker - Fixed details marker showing for search result in Firefox
- Fixed tabbing behavior when search query is not empty
- Switched TypeScript compilation target to ES2015
- Reduced size of JavaScript by 36% (
176kb→113kb) - Removed
mkdocsandreadthedocsthemes from Docker image
v6.0.0: mkdocs-material-6.0.0
Thanks to all sponsors for making this release possible!
- Improved search result look and feel
- Improved search result stability while typing
- Improved search result grouping (pages + headings)
- Improved search result relevance and scoring
- Added display of missing query terms to search results
- Reduced size of vendor bundle by 25% (
84kb→67kb) - Reduced size of the Docker image to improve CI build performance
- Removed hero partial in favor of custom implementation
- Removed deprecated front matter features
v5.5.14: mkdocs-material-5.5.14
- Improved spacing around image captions
- Fixed #1939: Long tables cause header overlap in print view
v5.5.13: mkdocs-material-5.5.13
- Improved abbreviations on touch devices
v5.5.12: mkdocs-material-5.5.12
- Fixed #1638: occasional
404for images when using instant loading
v5.5.11: mkdocs-material-5.5.11
- Fixed Disqus integration, as the minifier killed the config
v5.5.10: mkdocs-material-5.5.10
- Improved rendering by moving Disqus integration after page load
- Fixed #1887: Moved navigation icons to CSS to reduce size of HTML
v5.5.9: mkdocs-material-5.5.9
- Added Esperanto translations
- Fixed #1884: External links not included in navigation tabs
v5.5.8: mkdocs-material-5.5.8
- Removed focus outline on
detailsand content tabs for pointer devices - Improved accessibility of content tabs (now navigable via arrow keys)
- Fixed #1877:
404on search index when search is disabled - Fixed some memleaks in observable subscriptions
- Fixed color definitions for
theme-colormeta tag
v5.5.7: mkdocs-material-5.5.7
- Improved contrast ratio to 4.5:1 for syntax highlighting
- Improved contrast ratio to 4.5:1 for table of contents
v5.5.6: mkdocs-material-5.5.6
- Switched base template for
404.htmltomain.html - Fixed #1864: GitHub organisation stats not loading
v5.5.5: mkdocs-material-5.5.5
- Fixed missing vendor and worker distribution files
v5.5.4: mkdocs-material-5.5.4
- Added support for sortable data tables
v5.5.3: mkdocs-material-5.5.3
- Fixed search for languages other than English (5.5.1 regression)
v5.5.2: mkdocs-material-5.5.2
- Improved highlight colors and spacing for
ins,delandmark - Changed some keyboard symbols for better equivalents
- Removed focus
outlinefor details and code blocks on touch devices - Fixed margins for Admonitions (5.5.1 regression)
- Fixed too small content tab labels (5.5.1 regression)
- Fixed icon repeating for custom admonition icons
v5.5.1: mkdocs-material-5.5.1
- Improved typesetting by basing
font-sizeand spacings onem - Improved print view by slightly scaling down
font-size - Changed custom site title (metadata) to be suffixed with site name
- Fixed top- and bottom spacing of paragraphs inside table cells
v5.5.0: mkdocs-material-5.5.0
- Rewrite of entire documentation
- Rewrite of syntax highlighting to be customizable with CSS variables
- Improved syntax highlighting to work with light and dark theme
- Improved
slatecolor scheme to be more customizable and easier on the eyes - Added licenses of icon sets to distribution files
- Fixed stale document titles in Google Analytics when using instant loading
- Fixed width of previous and next footer links for tablet and above
- Fixed issues with top scroll margin for footnotes
- Fixed top margin for tabbed content when using a JavaScript highlighter
- Deprecated metadata-based redirects, source links and heroes
v5.4.0: mkdocs-material-5.4.0
- Added support to wrap searches in quotes to switch from
ORtoAND - Fixed highlighting of numbers in search results
v5.3.3: mkdocs-material-5.3.3
- Added Bengali translations
- Fixed #1773: Search for numbers does not return any result (regression)
v5.3.2: mkdocs-material-5.3.2
- Improved search type-ahead experience with non-Latin characters
- Fixed #1753: Japanese search doesn't work anymore
v5.3.1: mkdocs-material-5.3.1
- Fixed #1761: Duplication of search worker when subscribing to observable
v5.3.0: mkdocs-material-5.3.0
- Added support for color schemes based on user preference
- Fixed #1755: Tokenizer separator setting ignored
v5.2.3: mkdocs-material-5.2.3
- Improved search typeahead behavior for some languages (
de,fr, ...) - Improved styles for scrollbars on Firefox
- Fixed #1741: Removed
preconnecthint for Google Analytics
v5.2.2: mkdocs-material-5.2.2
- Fixed #1728: Legacy Edge doesn't support
degvalues inhslacolors
v5.2.1: mkdocs-material-5.2.1
- Fixed color of links in table headers, e.g. footnotes
- Fixed color scheme not being applied without primary or accent color
- Fixed hover delay for links inside code blocks
v5.2.0: mkdocs-material-5.2.0
- Added color schemes implementation + dark mode
- Fixed #1583: Missing option for separate link colors
v5.1.7: mkdocs-material-5.1.7
- Added keyboard focus support for overflowing code blocks
- Fixed #1696: Infinite loop in some cases when using instant loading
v5.1.6: mkdocs-material-5.1.6
- Added Burmese translations
- Added general anchor offset solution using
scroll-margin-top - Fixed #1653: Instant loading shouldn't intercept links to
*.htmlfiles
v5.1.5: mkdocs-material-5.1.5
- Added
nameattribute for social links to set linktitle - Fixed #1623: Allow arbitrary links in social links
- Fixed #1664: Height of
iframeis not adjustable - Fixed #1667: Sidebars are scrolled to bottom on load (bug in Chrome 81+)
v5.1.4: mkdocs-material-5.1.4
- Switched to @mdi/svg Material Design icon package
- Fixed #1655: Navigation may disappear after switching viewports
- Fixed #1659: Unnecessary scrollbar for search results on Windows
- Fixed occasional distortions for images with explicit dimensions
- Fixed errors in German translations
v5.1.3: mkdocs-material-5.1.3
- Fixed overflowing content area after switch to flexbox
v5.1.2: mkdocs-material-5.1.2
- Added status information to search observable
- Added status information to search modal
- Removed announcement bar from print media
- Removed media query packing logic due to race conditions
- Fixed #1520: Gracefully disable search on
file://if Worker fails - Fixed re-submission of query after search is initialized
- Fixed jitter of sidebars on all browsers by switching to
sticky
v5.1.1: mkdocs-material-5.1.1
- Added new FontAwesome icons
- Fixed #1609: Instant loading doesn't honor
target=_blank - Fixed GitHub stars count rounding errors
- Fixed GitLab stars count retrieval
v5.1.0: mkdocs-material-5.1.0
- Added support for icons from Markdown through mkdocs-material-extensions
v5.0.2: mkdocs-material-5.0.2
- Added CSS source maps to distribution files
- Fixed errors in Chinese (Traditional) translations
- Fixed creation of stale directory on installation from git
- Improved overflow scrolling behavior on iOS (reduced bundle size by
4kb)
v5.0.1: mkdocs-material-5.0.1
- Fixed syntax error in Spanish translation
v5.0.0: mkdocs-material-5.0.0
- Reactive architecture – try
app.dialog$.next("Hi!")in the console - Instant loading – make Material behave like a Single Page Application
- Improved CSS customization with CSS variables – set your brand's colors
- Improved CSS resilience, e.g. proper sidebar locking for customized headers
- Improved icon integration and configuration – now including over 5k icons
- Added possibility to use any icon for logo, repository and social links
- Search UI does not freeze anymore (moved to web worker)
- Search index built only once when using instant loading
- Improved extensible keyboard handling
- Support for prebuilt search indexes
- Support for displaying stars and forks for GitLab repositories
- Support for scroll snapping of sidebars and search results
- Reduced HTML and CSS footprint due to deprecation of Internet Explorer support
- Slight facelifting of some UI elements (Admonitions, tables, ...)
Configuration
- [ ] If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.