Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency mkdocs-material to v9 #2203

Merged
merged 1 commit into from
Oct 5, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 27, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mkdocs-material ^8.5.6 -> ^9.0.0 age adoption passing confidence

Release Notes

squidfunk/mkdocs-material (mkdocs-material)

v9.4.3: mkdocs-material-9.4.3

Compare Source

  • 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

Compare Source

  • 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 nav is 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.html
  • blog-post.html

v9.4.1: mkdocs-material-9.4.1

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Fixed crash of group plugin when used together with hooks

v9.3.0: mkdocs-material-9.3.0

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Switched dependencies to compatible release clauses
  • Removed readtime and lxml dependencies 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

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Added version to bug report name in info plugin
  • Updated Afrikaans translations

v9.2.3: mkdocs-material-9.2.3

Compare Source

  • Fixed blog plugin rendering wrongly with markdown.extensions.toc
  • Fixed blog plugin entrypoint generation

v9.2.2: mkdocs-material-9.2.2

Compare Source

  • 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

Compare Source

  • 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

Compare Source

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_url warning in social plugin
  • Improved blog plugin to automatically setup directory structure
  • Switched info plugin to importlib to 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.flat and Array.flatMap polyfill
  • 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 nav entry in mkdocs.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

Compare Source

  • Fixed MkDocs 1.4 compat issue in social plugin (9.1.20 regression)

v9.1.20: mkdocs-material-9.1.20

Compare Source

  • Updated Sanskrit translations
  • Fixed deprecation warnings for social plugin

v9.1.19: mkdocs-material-9.1.19

Compare Source

  • Added support for MkDocs 1.5+
  • Fixed #​5699: Improve error reporting in social plugin

v9.1.18: mkdocs-material-9.1.18

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Updated Indonesian translations
  • Ensure scroll bar follows color scheme of operating system

v9.1.15: mkdocs-material-9.1.15

Compare Source

  • Fixed #​5566: Indicate color scheme to operating system
  • Fixed #​5565: Update Dockerfile to 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

Compare Source

  • Updated Armenian and Greek translations

v9.1.13: mkdocs-material-9.1.13

Compare Source

  • Fixed #​5517: Social plugin crashes for some fonts (e.g. Open Sans)

v9.1.12: mkdocs-material-9.1.12

Compare Source

  • 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

Compare Source

  • Fixed #​5487: Social plugin crashes without options (9.1.10 regression)

v9.1.10: mkdocs-material-9.1.10

Compare Source

  • Added cards_layout_options setting for social cards
  • Deprecated cards_color and cards_font setting for social cards

v9.1.9: mkdocs-material-9.1.9

Compare Source

  • 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

Compare Source

  • Fixed #​5417: Theme breaks when palette is not defined (9.1.7 regression)

v9.1.7: mkdocs-material-9.1.7

Compare Source

  • 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

Compare Source

  • Updated Persian (Farsi) translations
  • Fixed #​5300: Boxes in Mermaid sequence diagrams not color-abiding

v9.1.5: mkdocs-material-9.1.5

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Added Kurdish (Soranî) translations
  • Updated Norwegian (Bokmål), Portuguese and Romanian translations
  • Improved compatibility with mkdocs-jupyter plugin
  • Fixed #​5198: Built-in search plugin not filtering script and style tags
  • Fixed #​5176: Back-to-top + instant loading not working (9.1.1 regression)

v9.1.2: mkdocs-material-9.1.2

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Docker image now available for amd64, arm64 and arm/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

Compare Source

  • Updated Chinese (Traditional) translations
  • Updated Hebrew translations

v9.0.14: mkdocs-material-9.0.14

Compare Source

  • Fixed #​5072: Rendering bug on navigation expand button in Firefox

v9.0.13: mkdocs-material-9.0.13

Compare Source

  • Updated Uzbek translations
  • Switched back to pre-9.0.0 headline detection in content partial
  • 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

Compare Source

  • 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

Compare Source

  • Added Mastodon verification for social links (rel=me)
  • Updated Italian translations

v9.0.10: mkdocs-material-9.0.10

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Fixed #​4842: Improved accessibility of search result list

v9.0.4: mkdocs-material-9.0.4

Compare Source

  • 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.com shutting down
  • Upgraded Python Markdown Extensions to 9.9.1

v9.0.3: mkdocs-material-9.0.3

Compare Source

  • 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

Compare Source

  • 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

Compare Source

  • Removed pipdeptree dependency 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

Compare Source

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 .title suffix 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

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from rjha-splunk as a code owner September 27, 2023 12:30
@renovate renovate bot added the dependencies Pull requests that update a dependency file label Sep 27, 2023
@renovate renovate bot requested a review from mstopa-splunk September 27, 2023 12:30
@renovate renovate bot force-pushed the renovate/mkdocs-material-9.x branch 6 times, most recently from 966697d to ec8d03f Compare October 5, 2023 10:18
@renovate renovate bot changed the base branch from main to develop October 5, 2023 10:18
@renovate renovate bot force-pushed the renovate/mkdocs-material-9.x branch 3 times, most recently from 8de5a75 to 14fb5b5 Compare October 5, 2023 12:09
@renovate renovate bot force-pushed the renovate/mkdocs-material-9.x branch from 14fb5b5 to 25fa8ed Compare October 5, 2023 12:27
@mstopa-splunk mstopa-splunk merged commit 32e10a4 into develop Oct 5, 2023
5 of 8 checks passed
@mstopa-splunk mstopa-splunk deleted the renovate/mkdocs-material-9.x branch October 5, 2023 12:27
@github-actions github-actions bot locked and limited conversation to collaborators Oct 5, 2023
@srv-rr-github-token
Copy link
Contributor

🎉 This PR is included in version 3.4.5-develop.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@srv-rr-github-token
Copy link
Contributor

🎉 This PR is included in version 3.4.6-develop.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file released on @develop
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants