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

build(deps): bump mkdocs-material from 8.5.11 to 9.0.0 #598

Merged
merged 1 commit into from
Jan 3, 2023

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 3, 2023

Bumps mkdocs-material from 8.5.11 to 9.0.0.

Release notes

Sourced from mkdocs-material's releases.

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

mkdocs-material-9.0.0b4

Note: this is a beta release – see #4714

  • Improved readability of search sharing link
  • Fixed search highlighting of occurrences found in tags
  • Fixed search sharing link using post transformed string (with wildcards etc.)
  • Fixed inability to query specific fields (e.g. tags:foo or title:bar)
  • Fixed inability to exclude search terms (e.g. -foo or -title:bar)

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.x.x

  • Removed pipdeptree dependency for info plugin
  • Fixed appearance of linked tags when hovered (9.0.0 regression)
  • Fixed #4810: Abbreviations run out of screen on touch devices

mkdocs-material-9.0.0 (2023-01-02)

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

mkdocs-material-8.5.11+insiders-4.27.0 (2022-12-20)

... (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
  • b95dffa Removed level 1 headline hack in content partial
  • 3901324 Updated .gitignore
  • 3b921f7 Updated copyright year
  • d25326f Updated site description in mkdocs.yml
  • 1b08038 Removed patch-level version spec where not necessary
  • 01b25dd Improved platform information in info plugin
  • fc6a368 Fixed alternative fragments in Mermaid diagrams
  • 23730a1 Merge pull request #4628 from squidfunk/feature/material-v9
  • a8c8583 Fixed hatch
  • 1295539 Added back hatch for release management
  • Additional commits viewable in compare view

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 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.11 to 9.0.0.
- [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.11...9.0.0)

---
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 requested a review from TomerFi as a code owner January 3, 2023 02:03
@dependabot dependabot bot added the type: dependencies Pull requests that update a dependency file label Jan 3, 2023
@pull-request-size pull-request-size bot added the size: xs Pull request has less then 10 lines label Jan 3, 2023
@auto-me-bot auto-me-bot bot added the status: needs review Pull request needs a review label Jan 3, 2023
@github-actions
Copy link

github-actions bot commented Jan 3, 2023

Test Results

36 tests   36 ✔️  1s ⏱️
  1 suites    0 💤
  1 files      0

Results for commit 631bef1.

@codecov
Copy link

codecov bot commented Jan 3, 2023

Codecov Report

Merging #598 (631bef1) into dev (ac66be4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #598   +/-   ##
=======================================
  Coverage   97.66%   97.66%           
=======================================
  Files           1        1           
  Lines         171      171           
=======================================
  Hits          167      167           
  Misses          4        4           

@auto-me-bot auto-me-bot bot removed the status: needs review Pull request needs a review label Jan 3, 2023
@TomerFi TomerFi merged commit 269132c into dev Jan 3, 2023
@auto-me-bot auto-me-bot bot added the status: approved Pull request is approved label Jan 3, 2023
@TomerFi TomerFi deleted the dependabot/pip/mkdocs-material-9.0.0 branch January 3, 2023 04:58
@auto-me-bot auto-me-bot bot added status: merged Pull request merged and removed status: approved Pull request is approved labels Jan 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: xs Pull request has less then 10 lines status: merged Pull request merged type: dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant