materialsproject / docs

Materials Project Documentation
https://docs.materialsproject.org
Other
14 stars 33 forks source link

Bump mkdocs-material from 5.5.13 to 8.2.9 #159

Closed dependabot[bot] closed 2 years ago

dependabot[bot] commented 2 years ago

Bumps mkdocs-material from 5.5.13 to 8.2.9.

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-8.2.9

  • Mitigate flicker on color palette switch by disabling all transitions
  • Fixed search suggestions not triggered when following deep link
  • Fixed incorrectly computed header height when using instant loading
  • Fixed #3782: Admonition titles have extra pixels on wide screens in Firefox
  • Fixed #3802: Always render table of contents container (except when hidden)

mkdocs-material-8.2.8

  • Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja
  • Reverted Jinja version range limitation (added in 8.2.7)
  • Improved styling of annotations and fixed borders of code blocks in tabs
  • Added background color to code blocks in focused/hovered links
  • Added check in tags plugin whether tags overview page exists
  • Fixed #3744: Content tab indicator on wrong position when using back button

mkdocs-material-8.2.7

  • Temporarily limit Jinja version range to < 3.1 due to breaking changes (see mkdocs/mkdocs#2794)

mkdocs-material-8.2.6

  • Fixed #3695: Deprecation warning for unescaped backslashes in templates
  • Fixed #3696: Annotations not mounted in some Terraform code blocks
  • Fixed #3698: Annotations not mounted in long code blocks (8.2.5 regression)

mkdocs-material-8.2.5

  • Fixed #3596: Mermaid not working when headline with name 'Mermaid' present
  • Fixed #3643: Reduce time to render pages with thousands of code blocks
  • Fixed #3665: Missing styles for Mermaid.js flowcharts cluster labels

mkdocs-material-8.2.4

  • Fixed malformed Google Fonts URL when a font setting was omitted
  • Fixed #3648: Fixed specificity issue with admonitions in lists
  • Fixed #3653: Invalid outdated version banner URL when using instant loading

mkdocs-material-8.2.3

  • Fixed #3578: Active element in table of contents off-by-one on large screens

mkdocs-material-8.2.2

  • Added automatic removal of query parameter when search is closed
  • Fixed #3599: Anchors always overriden when using navigation tracking

mkdocs-material-8.2.1

  • Fixed module material.plugins not being found (8.2.0 regression)

mkdocs-material-8.2.0

  • Added native support for Mermaid.js diagrams
  • Added native support for tags (with search integration)
  • Added support for staying on page when switching versions

mkdocs-material-8.1.11

  • Added Portuguese (Brasilian) translations

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-8.2.9 (2022-04-08)

  • Mitigate flicker on color palette switch by disabling all transitions
  • Fixed search suggestions not triggered when following deep link
  • Fixed incorrectly computed header height when using instant loading
  • Fixed #3782: Admonition titles have extra pixels on wide screens in Firefox
  • Fixed #3802: Always render table of contents container (except when hidden)

mkdocs-material-8.2.8+insiders-4.12.0 (2022-03-27)

  • Added support for card grids and grid layouts
  • Fixed #3685: Annotations sometimes broken when using instant loading
  • Fixed #3742: Automatically add Mermaid.js when building for offline usage

mkdocs-material-8.2.8 (2022-03-27)

  • Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja
  • Reverted Jinja version range limitation (added in 8.2.7)
  • Improved styling of annotations and fixed borders of code blocks in tabs
  • Added background color to code blocks in focused/hovered links
  • Added check in tags plugin whether tags overview page exists
  • Fixed #3744: Content tab indicator on wrong position when using back button

mkdocs-material-8.2.7 (2022-03-24)

  • Temporarily limit Jinja version range to < 3.1 due to breaking changes

mkdocs-material-8.2.6 (2022-03-23)

  • Fixed #3695: Deprecation warning for unescaped backslashes in templates
  • Fixed #3696: Annotations not mounted in some Terraform code blocks
  • Fixed #3698: Annotations not mounted in long code blocks (8.2.5 regression)

mkdocs-material-8.2.5+insiders-4.11.0 (2022-03-06)

  • Added support for excluding external assets from privacy plugin

mkdocs-material-8.2.5 (2022-03-06)

  • Fixed #3596: Mermaid not working when headline with name 'Mermaid' present
  • Fixed #3643: Reduce time to render pages with thousands of code blocks
  • Fixed #3665: Missing styles for Mermaid.js flowcharts cluster labels

mkdocs-material-8.2.4+insiders-4.10.1 (2022-03-02)

  • Added missing build dependencies to Dockerfile
  • Fixed encoding issues in privacy plugin, now forcing UTF-8 encoding
  • Fixed #3624: Scroll to active navigation item unreliable in Firefox
  • Fixed #3642: Privacy plugin errors when font setting was omitted

... (truncated)

Upgrade guide

Sourced from mkdocs-material's upgrade guide.


template: overrides/main.html

How to upgrade

Upgrade to the latest version with:

pip install --upgrade mkdocs-material

Show the currently installed version with:

pip show mkdocs-material

Upgrading from 7.x to 8.x

What's new?

  • Added support for code annotations
  • Added support for anchor tracking
  • Added support for version warning
  • Added copyright partial for easier override
  • Removed deprecated content tabs legacy implementation
  • Removed deprecated seealso admonition type
  • Removed deprecated site_keywords setting (unsupported by MkDocs)
  • Removed deprecated prebuilt search index support
  • Removed deprecated web app manifest – use customization
  • Removed extracopyright variable – use new copyright partial
  • Removed Disqus integation – use customization
  • Switched to :is() selectors for simple selector lists
  • Switched autoprefixer from last 4 years to last 2 years
  • Improved CSS overall to match modern standards
  • Improved CSS variable semantics for fonts
  • Improved extensibility by restructuring partials
  • Improved handling of details when printing
  • Improved keyboard navigation for footnotes
  • Fixed #3214: Search highlighting breaks site when empty

Changes to mkdocs.yml

pymdownx.tabbed

Support for the legacy style of the [Tabbed] extension was dropped in favor of the new, alternate implementation which has [better behavior on mobile viewports]:

... (truncated)

Commits
  • 007cbf8 Prepare 8.2.9 release
  • d30cf5b Revert last commit
  • f013fc6 Grant write permissions to documentation workflow
  • a03650f Grant write permissions to documentation workflow
  • 89e479d Bump minimist from 1.2.5 to 1.2.6 (#3805)
  • 1479e69 Added permissions for GitHub actions (#3804)
  • cc0f7a9 Fixed incorrectly computed header height when using instant loading
  • d926bb4 Added button to view source of every page
  • 52adc00 Documentation
  • dd2268f Added alternate syntax to Insider plugins example (#3783)
  • 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[bot] commented 2 years ago

Superseded by #160.