search

linuxserver / docker-documentation

The repo behind...
https://docs.linuxserver.io
GNU General Public License v3.0
172 stars 29 forks source link

Bump mkdocs-material from 8.5.11 to 9.0.3 #78

Closed dependabot[bot] closed 1 year ago

dependabot[bot] commented 1 year ago

Bumps mkdocs-material from 8.5.11 to 9.0.3.

Release notes

Sourced from mkdocs-material's releases.

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

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

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.0.3+insiders-4.27.1 (2022-01-08)

  • Fixed rendering of succeeding navigation items in typeset plugin
  • Fixed #4795: Built-in typeset plugin changes MkDocs' title precedence
  • Fixed #4724: Blog plugin not rendering integrate table of contents

mkdocs-material-9.0.3 (2022-01-08)

  • 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 h1-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

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

... (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
  • eab3eae Prepare 9.0.3 release
  • 35e6eed Updated dependencies
  • f8f44f5 Improved accessibility of sidebar navigation
  • 5b35b7d Updated Indonesian translations
  • 1d0f993 Updated Indonesian translations
  • 318903d Fixed anchor tracking not working for anchors in tables
  • 8a812ae Fixed search not closing on same anchor selection
  • 6825734 Improved collapsing of adjacent whitespace and removal of empty elements in s...
  • 7484b19 Removed unnecessary code from search plugin
  • 81e7b8c Fixed search plugin crashing on nested headlines
  • 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)