chore(deps): upgrade to mkdocs-material@9.7.6#908
Conversation
WalkthroughThis pull request upgrades the squidfunk/mkdocs-material Docker image from 2.7.2 to 9.7.6, updating references in the CI build task and README. It migrates mkdocs.yml to the new theme configuration format (repo metadata, nav key, light/dark palette toggles, markdown_extensions, analytics/social via extra config). Custom theme partials (nav-item, nav, footer, tabs, source) are rewritten to match the Material 9.x template API using macros and feature-flag-driven rendering. A themed logo pair is added to content/index.md, and a new CSS rule styles the copyright highlight. Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@mkdocs.yml`:
- Around line 379-382: The Material config block under extra is using a
misspelled key, so analytics is not being picked up. Update the key in
mkdocs.yml from the typo to the correct extra.analytics name, keeping the
existing provider and property values unchanged. Use the surrounding extra block
to locate the fix.
In `@theme/partials/nav-item.html`:
- Around line 203-209: The leaf-node branch in nav-item.html opens a <li> in the
else path but never closes it before the endif block, leaving the list markup
unbalanced. Update the nav-item template’s leaf branch so the <li> opened around
the nav_item.url link is properly closed after the <a> in the same branch,
matching the section branch’s structure and preserving the existing
render_content(nav_item) behavior.
In `@theme/partials/tabs.html`:
- Around line 8-9: Remove the leftover hardcoded tab links in tabs.html that
duplicate the migrated navigation entries and bypass site URL handling. Update
the tabs rendering to rely on the existing nav.items-driven navigation used by
the template rather than fixed "Stemcells" and "Releases" anchors, so links
respect config.site_url and use_directory_urls. If those pages are still needed,
move them into the navigation configuration instead of keeping them hardcoded in
the tabs partial.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 496b17ce-2743-4b52-a035-8c28b8a1de97
⛔ Files ignored due to path filters (1)
content/images/logo-full-white.pngis excluded by!**/*.png
📒 Files selected for processing (10)
README.mdci/tasks/build.ymlcontent/index.mdmkdocs.ymltheme/partials/copyright.htmltheme/partials/footer.htmltheme/partials/nav-item.htmltheme/partials/nav.htmltheme/partials/source.htmltheme/partials/tabs.html
- Migrated config - Migrated theme overrides Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
ad38b48 to
a896a9b
Compare
Use newer Material for MkDocs features to reduce reliance on custom theme overrides. Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@mkdocs.yml`:
- Around line 356-380: The Markdown config is enabling pymdownx.highlight
without the Material-recommended options needed for full code-block highlighting
support. Update the markdown_extensions entry for pymdownx.highlight in
mkdocs.yml to include anchor_linenums, line_spans, and pygments_lang_class, and
keep it alongside pymdownx.inlinehilite, pymdownx.snippets, and
pymdownx.superfences so the code-copy and line-anchor behavior works as
intended.
In `@theme/partials/nav-item.html`:
- Around line 196-201: The pseudo-section branch in nav-item.html renders an
interactive label without a matching input, so update the is_section == True
path to use non-interactive heading markup instead of a label. In the nav item
template, keep the existing rendering logic around render_content(nav_item) and
md-nav__icon, but remove the for/id/tabindex label behavior for this
pseudo-section case so it cannot emit an empty tabindex or act as a toggle.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 69b08055-a0fa-44e4-b8f4-381722066a5f
⛔ Files ignored due to path filters (1)
content/images/logo-full-white.pngis excluded by!**/*.png
📒 Files selected for processing (10)
README.mdci/tasks/build.ymlcontent/index.mdmkdocs.ymltheme/assets/stylesheets/extra.61026d2ee9f4.csstheme/partials/footer.htmltheme/partials/nav-item.htmltheme/partials/nav.htmltheme/partials/source.htmltheme/partials/tabs.html
💤 Files with no reviewable changes (4)
- theme/partials/nav.html
- theme/partials/footer.html
- theme/partials/source.html
- theme/partials/tabs.html
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Code highlight used by the docs does not depend on this module Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Note
This must be merged in tandem with cloudfoundry/bosh-io-web#81 to prevent a broken website deploy.
This brings the docs up to date with the latest version of Material for MkDocs (v9.7.6):
Noticeable benefits are mostly niceities:
mkdocs.ymlconfig and templates are now aligned with the Material for MKDocs documentation