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

Bump mkdocs-material from 8.5.10 to 9.2.2 in /docs #804

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 22, 2023

Bumps mkdocs-material from 8.5.10 to 9.2.2.

Release notes

Sourced from mkdocs-material's releases.

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

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

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_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

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.2.2 (2023-08-22)

  • Fixed #5880: Blog plugin failing when building a standalone blog
  • Fixed #5881: Blog plugin not compatible with Python < 3.10

mkdocs-material-9.2.1 (2023-08-21)

  • 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

mkdocs-material-9.2.0+insiders-4.39.1 (2023-08-21)

  • Fixed git diff in tags plugin after merging back 9.2.0 changes

mkdocs-material-9.2.0 (2023-08-21)

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

... (truncated)

Upgrade guide

Sourced from mkdocs-material's upgrade guide.

How to upgrade

Upgrade to the latest version with:

pip install --upgrade --force-reinstall mkdocs-material

Show the currently installed version with:

pip show mkdocs-material

Upgrading from 8.x to 9.x

This major release includes a brand new search implementation that is faster and allows for rich previews, advanced tokenization and better highlighting. It was available as part of Insiders for over a year, and now that the funding goal was hit, makes its way into the community edition.

Changes to mkdocs.yml

content.code.copy

The copy-to-clipboard buttons are now opt-in and can be enabled or disabled per block. If you wish to enable them for all code blocks, add the following lines to mkdocs.yml:

theme:
  features:
    - content.code.copy

content.action.*

A "view source" button can be shown next to the "edit this page" button, both of which must now be explicitly enabled. Add the following lines to mkdocs.yml:

theme:
  features:
    - content.action.edit
    - content.action.view

navigation.footer

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 8.5.10 to 9.2.2.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Upgrade guide](https://github.com/squidfunk/mkdocs-material/blob/master/docs/upgrade.md)
- [Commits](squidfunk/mkdocs-material@8.5.10...9.2.2)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants