Merge remote-tracking branch 'upstream/master'

CHANGELOG

@@ -1,3 +1,8 @@
+mkdocs-material-8.5.4 (2022-09-30)
+
+  * Fixed expand icons shift on sidebar overflow (using scrollbar-gutter)
+  * Fixed #4429: Text in sequence diagrams overflows in Firefox
+
 mkdocs-material-8.5.3+insiders-4.24.0 (2022-09-27)
 
   * Added support for custom content on index pages (blog)

README.md

@@ -137,6 +137,9 @@
   <a href="https://sealvault.org/" target=_blank><img
     src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sealvault.png" height="58"
   /></a>
+  <a href="https://neptune.ai/" target=_blank><img
+    src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png" height="58"
+  /></a>
 </p>
 <p>&nbsp;</p>
 

docs/changelog/index.md

@@ -6,6 +6,11 @@ template: overrides/main.html
 
 ## Material for MkDocs
 
+### 8.5.4 <small>_ September 30, 2022</small> { id="8.5.4" }
+
+- Fixed expand icons shift on sidebar overflow (using `scrollbar-gutter`)
+- Fixed #4429: Text in sequence diagrams overflows in Firefox
+
 ### 8.5.3 <small>_ September 20, 2022</small> { id="8.5.3" }
 
 - Fixed build error when enabling cookie consent without analytics

docs/insiders/changelog.md

@@ -6,6 +6,10 @@ template: overrides/main.html
 
 ## Material for MkDocs Insiders
 
+### 4.24.1 <small>_ September 30, 2022</small> { id="4.24.1" }
+
+- Fixed #4430: Builds fails with MkDocs 1.4.0
+
 ### 4.24.0 <small>_ September 27, 2022</small> { id="4.24.0" }
 
 - Added support for custom content on index pages (blog)

docs/insiders/index.md

@@ -183,6 +183,7 @@ You can cancel your sponsorship anytime.[^5]
 [![Automation Technology]](https://automationtechnology.de/){ target=_blank title="Automation Technology" }
 [![Eccenca]](https://eccenca.com/){ target=_blank title="Eccenca" }
 [![SealVault]](https://sealvault.org/){ target=_blank title="SealVault" }
+[![Neptune]](https://neptune.ai/){ target=_blank title="Neptune" }
 
 </div>
 
@@ -211,6 +212,7 @@ You can cancel your sponsorship anytime.[^5]
   [Automation Technology]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-automation-technology.png
   [Eccenca]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png
   [SealVault]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sealvault.png
+  [Neptune]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png
 
 <hr />
 

docs/setup/extensions/python-markdown-extensions.md

@@ -643,7 +643,7 @@ markdown_extensions:
 
 The following configuration options are supported:
 
-[`alternate_style`](#+pymdownx.tabbed.alternate_style){ #+pymdownx.tabbed:alternate_style }
+[`alternate_style`](#+pymdownx.tabbed.alternate_style){ #+pymdownx.tabbed.alternate_style }
 
 :   [:octicons-tag-24: 7.3.1][Tabbed alternate support] ·
     :octicons-milestone-24: Default: `false` · :octicons-alert-24: __Required__
@@ -692,7 +692,7 @@ markdown_extensions:
 
 The following configuration options are supported:
 
-[`custom_checkbox`](#+pymdownx.tasklist.custom_checkbox){ #+pymdownx.tasklist:custom_checkbox }
+[`custom_checkbox`](#+pymdownx.tasklist.custom_checkbox){ #+pymdownx.tasklist.custom_checkbox }
 
 :   :octicons-milestone-24: Default: `false` · This option toggles the rendering
     style of checkboxes, replacing native checkbox styles with beautiful icons, 
@@ -704,7 +704,7 @@ The following configuration options are supported:
           custom_checkbox: true
     ```
 
-[`clickable_checkbox`](#+pymdownx.tasklist.clickable_checkbox){ #+pymdownx.tasklist:clickable_checkbox }
+[`clickable_checkbox`](#+pymdownx.tasklist.clickable_checkbox){ #+pymdownx.tasklist.clickable_checkbox }
 
 :   :octicons-milestone-24: Default: `false` · This option toggles whether
     checkboxes are clickable. As the state is not persisted, the use of this 

docs/setup/setting-up-social-cards.md

@@ -186,7 +186,8 @@ dependencies on your system:
 
     As stated in the [installation guide], the easiest way to get up and running
     with the [Cairo Graphics] library on Windows is by installing [GTK+], since
-    it has Cairo as a dependency.
+    it has Cairo as a dependency. You can also download and install a
+    precompiled [GTK runtime].
 
 === ":material-linux: Linux"
 
@@ -219,6 +220,7 @@ dependencies on your system:
   [Homebrew]: https://brew.sh/
   [installation guide]: https://www.cairographics.org/download/
   [GTK+]: https://www.gtk.org/docs/installations/windows/
+  [GTK runtime]: https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases
 
 #### Caching <small>recommended</small> { #caching data-toc-label="Caching" }
 

material/base.html

@@ -31,7 +31,7 @@
         <link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
       {% endif %}
       <link rel="icon" href="{{ config.theme.favicon | url }}">
-      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.5.3+insiders-4.24.0">
+      <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-8.5.4+insiders-4.24.1">
     {% endblock %}
     {% block htmltitle %}
       {% if page.meta and page.meta.title %}
@@ -43,7 +43,7 @@
       {% endif %}
     {% endblock %}
     {% block styles %}
-      <link rel="stylesheet" href="{{ 'assets/stylesheets/main.38a480a7.min.css' | url }}">
+      <link rel="stylesheet" href="{{ 'assets/stylesheets/main.31f1ec4d.min.css' | url }}">
       {% if config.theme.palette %}
         {% set palette = config.theme.palette %}
         <link rel="stylesheet" href="{{ 'assets/stylesheets/palette.cbb835fc.min.css' | url }}">
@@ -251,7 +251,7 @@
       </script>
     {% endblock %}
     {% block scripts %}
-      <script src="{{ 'assets/javascripts/bundle.f4c6f307.min.js' | url }}"></script>
+      <script src="{{ 'assets/javascripts/bundle.b7e8f764.min.js' | url }}"></script>
       {% for path in config.extra_javascript %}
         <script src="{{ path | url }}"></script>
       {% endfor %}

material/partials/consent.html

@@ -7,7 +7,7 @@
     {% set _ = cookies.update({ "analytics": "Google Analytics" }) %}
   {% endif %}
 {% endif %}
-{% if "github.com" in config.repo_url %}
+{% if config.repo_url and "github.com" in config.repo_url %}
   {% if "github" not in cookies %}
     {% set _ = cookies.update({ "github": "GitHub" }) %}
   {% endif %}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "mkdocs-material",
-  "version": "8.5.3+insiders-4.24.0",
+  "version": "8.5.4+insiders-4.24.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "mkdocs-material",
-      "version": "8.5.3+insiders-4.24.0",
+      "version": "8.5.4+insiders-4.24.1",
       "license": "MIT",
       "dependencies": {
         "array-flat-polyfill": "^1.0.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mkdocs-material",
-  "version": "8.5.3+insiders-4.24.0",
+  "version": "8.5.4+insiders-4.24.1",
   "description": "Documentation that simply works",
   "keywords": [
     "mkdocs",

src/assets/javascripts/components/content/code/mermaid/index.css

@@ -337,9 +337,10 @@ line {
   stroke: var(--md-mermaid-edge-color);
 }
 
-/* Sequence message and loop text */
+/* Sequence message, loop and note text */
 .messageText,
-.loopText > tspan {
+.loopText > tspan,
+.noteText > tspan {
   font-family: var(--md-mermaid-font-family) !important;
   fill: var(--md-mermaid-edge-color);
   stroke: none;

src/assets/javascripts/components/content/code/mermaid/index.ts

@@ -92,7 +92,12 @@ export function mountMermaid(
     .pipe(
       tap(() => mermaid.initialize({
         startOnLoad: false,
-        themeCSS
+        themeCSS,
+        sequence: {
+          actorFontSize: "16px", // Hack: mitigate https://bit.ly/3y0NEi3
+          messageFontSize: "16px",
+          noteFontSize: "16px"
+        }
       })),
       map(() => undefined),
       shareReplay(1)

src/assets/stylesheets/main/layout/_sidebar.scss

@@ -130,6 +130,7 @@
     // this reason, we disable scroll snapping until this is resolved (#1667).
     // scroll-snap-type: y mandatory;
     scrollbar-width: thin;
+    scrollbar-gutter: stable;
     scrollbar-color: var(--md-default-fg-color--lighter) transparent;
 
     // Sidebar scroll wrapper on hover
@@ -154,19 +155,24 @@
     }
   }
 
-  // Sidebar wrapper
-  &__inner {
+  // Hack: the scrollbar is only visible when the sidebar's contents overflow,
+  // which is nice, but leads to the problem where the chevrons of expandable
+  // sections will jump by `4px` when the sidebar is shown. We wanted to fix
+  // this problem for so long, but haven't found a clean way of doing it.
+  // Until now. The following declaration is only applied to Webkit browsers
+  // (e.g. Chrome and Safari), which support styling of scrollbars. The trick
+  // is to add conditional padding on the side of the scrollbar only if the
+  // sidebar's content doesn't overflow. This hack is inspired and adapted
+  // from Ayke van Laëthem's year old trick – see https://bit.ly/3Sb1qql
+  @supports selector(::-webkit-scrollbar) {
 
-    // Hack: the scrollbar is only visible when the sidebar's contents overflow,
-    // which is nice, but leads to the problem where the chevrons of expandable
-    // sections will jump by `4px` when the sidebar is shown. We wanted to fix
-    // this problem for so long, but haven't found a clean way of doing it.
-    // Until now. The following declaration is only applied to Webkit browsers
-    // (e.g. Chrome and Safari), which support styling of scrollbars. The trick
-    // is to add conditional padding on the side of the scrollbar only if the
-    // sidebar's content doesn't overflow. This hack is inspired and adapted
-    // from Ayke van Laëthem's year old trick – see https://bit.ly/3Sb1qql
-    @supports selector(::-webkit-scrollbar) {
+    // Sidebar scroll wrapper
+    &__scrollwrap {
+      scrollbar-gutter: auto;
+    }
+
+    // Sidebar wrapper
+    &__inner {
       padding-inline-end: calc(100% - #{px2rem(230px)});
     }
   }