Migrate from Material for MkDocs to Zensical + uv#1135
Open
josecsotomorales wants to merge 1 commit into
Open
Conversation
Migrate the User Guide from Material for MkDocs to Zensical (modern theme
variant) and from pip/requirements.txt to uv/pyproject.toml.
Tooling
- Add pyproject.toml, .python-version (3.12), uv.lock; drop requirements.txt
- Native zensical.toml config (replaces mkdocs.yml); build output verified
byte-identical between the two configs before removing mkdocs.yml
Plugin gaps (Zensical reimplements MkDocs plugins as modules)
- include-markdown -> main.py macros module; components/ moved to repo root
- redirects -> redirects.yml + scripts/generate-redirects.py (349 stubs)
- print-site -> docs/stylesheets/print.css + browser Print->PDF
- render_macros:false front-matter on docs with literal {{token}} syntax
Design (modern theme)
- Redesigned homepage (hero + filterable destination cards)
- tokens.css / components.css / home.css design system; branded 404;
nav and search polish
CI and dev tooling
- ci.yml: uv + zensical build + redirect stubs + gh-pages deploy
- pre-commit, scripts, and .vscode rewired to uv/zensical
Also fixes 67 pre-existing build warnings (type-annotation bracket
false-positives + broken internal links) and removes legacy files
(includes/, archived/, stray dirs).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the User Guide from Material for MkDocs (now in maintenance mode) to Zensical — its official successor — on the modern theme, and from
pip/requirements.txtto uv/pyproject.toml. Also modernizes the design and fixes all pre-existing build warnings.Build output was verified byte-identical between the old
mkdocs.ymland the newzensical.tomlbeforemkdocs.ymlwas removed, and the final build reports 0 issues.Tooling: pip → uv
pyproject.toml+.python-version(3.12) + committeduv.lock; removedrequirements.txtuv run zensical serve/uv run zensical buildConfig:
mkdocs.yml→ nativezensical.tomlextra(GA + feedback), and markdown extensionszensical.extensions.*(no YAML compat shim)Engineering around unsupported MkDocs plugins
Zensical reimplements MkDocs plugins as modules; these aren't shipped yet, so:
main.pymacros module ({{ general_props('all-props') }}, etc.);components/moved to repo root (124 directives across 54 files migrated)redirects.yml+scripts/generate-redirects.py(349 meta-refresh stubs, preserving query/hash, with canonical tags)docs/stylesheets/print.css+ browser Print → Save as PDF{{token}}docs (notification variables, API examples) getrender_macros: falseModern design
card-filter.js)tokens.css), reusable components (components.css), homepage styles (home.css), improved dark-mode contrastCI & dev tooling
ci.yml:astral-sh/setup-uv→uv run zensical build→ redirect stubs →peaceiris/actions-gh-pages(samegh-pagesmodel,cnamepreserved).vscoderewired touv/zensicalCleanups
requirements.txt,includes/,archived/use-cases/, the oldcheck-mkdocs-warnings.sh, and a stray empty dirVerification
uv run zensical build— No issues foundzensical.tomlvsmkdocs.ymlbuilds were byte-identicaluv run pre-commit run --all-files— all hooks passNotes for reviewers
gh-pages)docs/settings/integrations/ticketing/jira.mdshadows its own redirect — flagged for separate cleanup, not touched here🤖 Generated with Claude Code