chore(deps): upgrade to mkdocs-material@9.7.6

README.md

@@ -19,12 +19,12 @@ git submodule update --init --recursive
 
 # for quick development reloads
 docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" \
-  squidfunk/mkdocs-material:2.7.2 \
+  squidfunk/mkdocs-material:9.7.6 \
   -- serve --dev-addr=0.0.0.0:8000 --dirtyreload
 
 # for a production-like build environment (link checking, etc.)
 docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" \
-  squidfunk/mkdocs-material:2.7.2
+  squidfunk/mkdocs-material:9.7.6
 ```
 
 You can then make changes in a text editor, and refresh in a local browser at <http://localhost:8000/>.

ci/tasks/build.yml

@@ -3,7 +3,7 @@ image_resource:
   type: registry-image
   source:
     repository: squidfunk/mkdocs-material
-    tag: 2.7.2
+    tag: 9.7.6
 run:
   dir: docs
   path: /usr/bin/mkdocs

content/index.md

@@ -1,6 +1,7 @@
 # Welcome to
 
-![Cloud Foundry BOSH](images/logo-full.png)
+![Cloud Foundry BOSH](images/logo-full.png#only-light)
+![Cloud Foundry BOSH](images/logo-full-white.png#only-dark)
 
 BOSH is a project that unifies release engineering, deployment, and lifecycle management of small and large-scale cloud software. BOSH can provision and deploy software over hundreds of VMs. It also performs monitoring, failure recovery, and software updates with zero-to-minimal downtime.
 

mkdocs.yml

@@ -1,14 +1,15 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
 site_name: Cloud Foundry BOSH
 site_url: "https://bosh.io/docs/"
 
-repo_name: 'cloudfoundry/docs-bosh'
-repo_url: 'https://github.com/cloudfoundry/docs-bosh'
-edit_uri: edit/master/content/
+repo_name: cloudfoundry/bosh
+repo_url: https://github.com/cloudfoundry/bosh
+edit_uri: https://github.com/cloudfoundry/docs-bosh/edit/master/content/
 
 # non-default since our repo itself is called "docs"
 docs_dir: content
 
-pages:
+nav:
 - About:
   - Welcome: index.md
   - Project Goals: problems.md
@@ -258,7 +259,6 @@ pages:
     - What is a Stemcell?: stemcell.md
     - Recent Changes: recent.md
     - Deploying BOSH with create-env: init.md
-
   - "--- Cloud Providers": divider.md
   - Alibaba Cloud:
     - Usage: alicloud-cpi.md
@@ -309,33 +309,60 @@ pages:
     - Using Human-readable VM names: vsphere-human-readable-names.md
   - Warden:
     - Usage: warden-cpi.md
-# this hack avoids divider.md showing up in navigation and site search
-- "--- ": divider.md
-
+- Stemcells: '/stemcells/'
+- Releases: '/releases/'
+      
 theme:
   name: material
   custom_dir: theme
   favicon: assets/images/favicon.2776d0bae488.png
-  feature:
-    tabs: true
+  features:
+    - content.action.edit
+    - content.code.copy
+    - navigation.tabs
+    - navigation.footer
   palette:
-    primary: blue
-    accent: indigo
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+      primary: blue
+      accent: indigo
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+      primary: blue
+      accent: indigo
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+      primary: blue
+      accent: indigo
+
   logo: assets/images/logo.d93e7da69dbf.png
 
 extra_css:
 - 'assets/stylesheets/extra.61026d2ee9f4.css'
 
 markdown_extensions:
 - markdown.extensions.admonition
-- markdown.extensions.codehilite
 - markdown.extensions.def_list
 - markdown.extensions.attr_list
 - markdown.extensions.footnotes
-- markdown.extensions.meta
-- markdown.extensions.toc(permalink=true)
+- markdown.extensions.toc:
+    permalink: true
 - pymdownx.arithmatex
-- pymdownx.betterem(smart_enable=all)
+- pymdownx.betterem:
+    smart_enable: all
 - pymdownx.caret
 - pymdownx.critic
 - pymdownx.emoji:
@@ -346,20 +373,29 @@ markdown_extensions:
 - pymdownx.smartsymbols
 - pymdownx.snippets
 - pymdownx.superfences
-- pymdownx.tasklist(custom_checkbox=true)
+- pymdownx.tasklist:
+    custom_checkbox: true
 - pymdownx.tilde
 
 extra:
+  analytics:
+    provider: google
+    property: !ENV GOOGLE_ANALYTICS_KEY  # avoid forks accidentally using us
+
   social:
-  - type: 'github'
+  - icon: fontawesome/brands/github
     link: 'https://github.com/cloudfoundry/bosh'
-  - type: 'slack'
+  - icon: fontawesome/brands/slack
     link: 'https://cloudfoundry.slack.com/messages/C02HPPYQ2/'
 
-google_analytics:
-# avoid forks accidentally using us
-- !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
-- auto
+  generator: false
 
+copyright: >
+  powered by
+  <a href="https://github.com/bosh-io/web" target="_blank" rel="noopener">bosh-io/web</a>,
+  <a href="https://github.com/mkdocs/mkdocs" target="_blank" rel="noopener">mkdocs</a>
+  and
+  <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">material</a>
+
 # since we publish via bosh.io, avoid unintentionally using gh-pages
 remote_branch: docroot

theme/assets/stylesheets/extra.61026d2ee9f4.css

@@ -2,9 +2,9 @@
 .bosh-schema blockquote {
   padding-bottom: .01rem;
   padding-left: 1.8rem;
-  margin-left: 1.4rem;
+  margin-left: 1rem;
   border-left: .4rem solid rgba(0,0,0,.18);
-  color: rgba(0,0,0,.87);
+  color: var(--md-typeset-color);
 }
 
 /* in headers, the codehilite causes distracting indenting */
@@ -24,9 +24,8 @@
 .bosh-schema h4,
 .bosh-schema h5,
 .bosh-schema h6 {
-  font-size: 2rem;
+  font-size: 1rem;
   font-weight: 600;
-  margin-top: 3.2rem;
   text-transform: none;
 }
 
@@ -42,11 +41,45 @@
     display: table;
 }
 
-.bosh-schema dd {
-  margin: 0 0 .25em 6em
+[dir="ltr"] .bosh-schema dd {
+  margin: 0 0 0 6em;
 }
 
 .bosh-schema dt {
   font-style: italic;
   position: absolute;
 }
+
+.md-copyright__highlight {
+    color: inherit;
+}
+
+
+/* START Primary Sidebar */
+
+@media screen and (max-width: 76.2344em) {
+  .md-nav--lifted > .md-nav__list {
+    &:has(> .md-nav__item--bosh-sidebar-sticky-bottom) { padding-bottom: 1.2rem; }
+    > .md-nav__item--bosh-sidebar-sticky-bottom {
+        position: absolute;
+        bottom: 0;
+        width: 100%;
+        background: inherit;
+    }
+  }
+}
+
+@media screen and (min-width: 76.25em) {
+  .md-nav--lifted > .md-nav__list {
+     > .md-nav__item--bosh-persistent {
+       display: block;
+       margin-top: 0;
+       > .md-nav__link {
+         > .md-ellipsis { cursor: default; }
+         > .md-nav__icon { display: none; }
+       }
+     }
+     > .md-nav__item--bosh-persistent + .md-nav__item { margin-top: 1.2rem; }
+  }
+}
+/* END Primary Sidebar */