Skip to content

Commit 11c90bf

Browse files
rf-rajj: modernise mkdocs-material 5.5.9 → 9.x
CI image bump: .github/workflows/docs-workflow.yml — squidfunk/mkdocs-material:5.5.9 → :9. Following the bead's Phase 5 plan, will re-pin to a specific 9.x.y tag once this lands cleanly on master. mkdocs.yml migrations: theme.features: - tabs → navigation.tabs - (added navigation.footer to compensate for the deleted footer-partial override; the prev/next pagination is now Material's default behaviour gated on this feature) theme.hljs_languages: - removed; Material 9 uses pymdownx.superfences + pygments and detects Clojure automatically from ```clojure fenced blocks. Verified by build: site/subscriptions/index.html has highlight-class hits on every Clojure block. Custom-dir audit (the careful part): Two of the six theme override files were unmodified verbatim copies of Material 5's partials, with no project-specific customisation. Their HTML used Material 5's BEM names (md-header-nav__*, md-footer-nav__*) which Material 9 renamed to md-header__* / md-footer__*. Keeping them under Material 9 would have rendered the header and footer with class names that no Material 9 CSS rule targets — silent visual breakage with no build error. Deleted (no customisation, stale class names): docs/theme/partials/header.html docs/theme/partials/footer.html Kept (real customisations, blocks still valid in Material 9): docs/theme/main.html — block htmltitle (no " - site_name" suffix), block footer (loads docs.js) docs/theme/404.html — custom 404 content (block content) docs/theme/overrides/main.html — OG/Twitter meta (block extrahead) docs/theme/overrides/home.html — homepage hero (block tabs) Side-effect of deleting the partials: we now also gain palette-toggle hooks, alternate-language switcher, sticky-tabs support, and modern search styling that the old verbatim copies were silently masking. Verified locally with docker run --rm -v "\$PWD":/docs squidfunk/mkdocs-material:9 build: - 0 deprecation warnings on the migrated config - 0 template-resolution errors on the trimmed custom_dir - md-header__* and md-footer__* classes present in rendered HTML - md-tabs nav element rendered (navigation.tabs working) - md-footer__link--prev / md-footer__link--next rendered (navigation.footer working) - Clojure code blocks highlight correctly without hljs_languages - Custom 404 (not-found-container, 404-img.png) survived block content - 5 pre-existing warnings (releases/2016.md broken links, README/index conflict) unchanged from the Material 5 baseline; not migration-induced Phase 4 visual-review gate per the bead is operator-owned; the build artifact is in /docs/site for inspection. After visual approval, Phase 5 is to re-pin :9 to a specific 9.x.y tag. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d128981 commit 11c90bf

4 files changed

Lines changed: 3 additions & 184 deletions

File tree

‎.github/workflows/docs-workflow.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ jobs:
8181
- re-frame-docs-app
8282
runs-on: ubuntu-24.04
8383
container:
84-
image: "squidfunk/mkdocs-material:5.5.9"
84+
image: "squidfunk/mkdocs-material:9"
8585
steps:
8686
- name: Checkout Current Branch
8787
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4

‎docs/theme/partials/footer.html‎

Lines changed: 0 additions & 100 deletions
This file was deleted.

‎docs/theme/partials/header.html‎

Lines changed: 0 additions & 80 deletions
This file was deleted.

‎mkdocs.yml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@ theme:
2222
text: IBM Plex Sans
2323
code: Source Code Pro
2424
features:
25-
- tabs
25+
- navigation.tabs
26+
- navigation.footer
2627
- content.code.annotate
2728
- content.code.copy
28-
hljs_languages:
29-
- clojure
3029

3130
extra:
3231
social:

0 commit comments

Comments
 (0)