Skip to content

Commit 71a6daa

Browse files
chore: migrate from MkDocs Material to Zensical
- Replaced mkdocs-material with zensical in requirements.txt - Updated mike to use squidfunk/mike fork - Set theme variant to 'classic' to maintain Material UI - Fixed version-badge.js base path routing for local mike deployment
1 parent 5b3d0d8 commit 71a6daa

3 files changed

Lines changed: 7 additions & 2 deletions

File tree

docs/javascripts/version-badge.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
/* ── URL helpers ─────────────────────────────────────────────────────── */
1616

1717
function getBasePath() {
18+
// If we're running locally via mike serve, the base path is just /
19+
if (window.location.hostname === 'localhost' || window.location.hostname === '127.0.0.1') {
20+
return '/';
21+
}
1822
var m = window.location.pathname.match(/^(\/[^/]+\/)/);
1923
return m ? m[1] : '/';
2024
}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ edit_uri: blob/main/docs/
1111
#Configuration
1212
theme:
1313
name: material
14+
variant: classic
1415
custom_dir: overrides
1516
logo: images/VMware_by_Broadcom_White.png
1617
font:

requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
mkdocs-material==9.7.7
1+
zensical
22
mkdocs-glightbox==0.5.2
3-
mike>=2.2.0
3+
git+https://github.com/squidfunk/mike.git

0 commit comments

Comments
 (0)