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-dev): bump mkdocs-material from 8.5.11 to 9.0.2 #1808

Merged
merged 1 commit into from
Jan 5, 2023

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps mkdocs-material from 8.5.11 to 9.0.2.

Release notes

Sourced from mkdocs-material's releases.

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

mkdocs-material-9.0.1

  • 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

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

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.0.2 (2022-01-04)

  • 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

mkdocs-material-9.0.1 (2022-01-03)

  • 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

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

... (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
  • 9df1bee Merge pull request #4826 from squidfunk/dependabot/npm_and_yarn/json5-1.0.2
  • 7ca35b9 Bump json5 from 1.0.1 to 1.0.2
  • f8a3e83 Prepare 9.0.2 release
  • 157b4f2 Updated distribution files
  • bc8a070 Merge branch 'master' of github.com:squidfunk/mkdocs-material
  • 38e2914 Improved contrast ratio in footer to meet WCAG guidelines
  • b007fbb Documentation (#4825)
  • c8fb426 Fixed crashing of social plugin when cards are disabled
  • 491bd0a Fixed wrong content.action.* feature flags
  • 4548afb Fixed search plugin crashing on page titles
  • 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)

@dependabot dependabot bot requested a review from a team as a code owner January 4, 2023 20:05
@dependabot dependabot bot requested review from leandrodamascena and removed request for a team January 4, 2023 20:05
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jan 4, 2023
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 4, 2023
@github-actions github-actions bot added the internal Maintenance changes label Jan 4, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jan 4, 2023

Codecov Report

Base: 97.58% // Head: 97.58% // No change to project coverage 👍

Coverage data is based on head (58a0932) compared to base (0f4047d).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1808   +/-   ##
========================================
  Coverage    97.58%   97.58%           
========================================
  Files          141      141           
  Lines         6425     6425           
  Branches       442      442           
========================================
  Hits          6270     6270           
  Misses         123      123           
  Partials        32       32           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@dependabot dependabot bot force-pushed the dependabot/pip/develop/mkdocs-material-9.0.2 branch 4 times, most recently from 7b192a0 to f8aa67e Compare January 5, 2023 08:50
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 8.5.11 to 9.0.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.11...9.0.2)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/develop/mkdocs-material-9.0.2 branch from f8aa67e to 58a0932 Compare January 5, 2023 09:00
@rubenfonseca
Copy link
Contributor

Checked the rendered docs and they look good.

@rubenfonseca rubenfonseca merged commit e42ae0d into develop Jan 5, 2023
@rubenfonseca rubenfonseca deleted the dependabot/pip/develop/mkdocs-material-9.0.2 branch January 5, 2023 10:46
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 internal Maintenance changes python Pull requests that update Python code size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants