feat(docs): migrate documentation site from Material for MkDocs to Zensical#41357
feat(docs): migrate documentation site from Material for MkDocs to Zensical#41357
Conversation
|
|
|
|
Co-authored-by: jamietanna <3315059+jamietanna@users.noreply.github.com>
There was a problem hiding this comment.
We want to keep this, idaelly
There was a problem hiding this comment.
Restored in 711000c. The file is back in tools/mkdocs/mkdocs-hooks/custom-edit-url.py.
| - [@Gabriel-Ladzaretti](https://github.com/Gabriel-Ladzaretti) S3 repo cache, child process refactoring, others | ||
| - [@not7cd](https://github.com/not7cd) improved the `pip-compile` manager | ||
| - [@squidfunk](https://github.com/squidfunk) for creating and maintaining the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) framework, that we use to build our docs, and for helping us with problems with the framework, or our docs | ||
| - [The MkDocs project](https://www.mkdocs.org/) for making the static site generator, that we use to build our docs |
There was a problem hiding this comment.
IMO, let's keep this note (that we thank MkDocs for the past work), as well as adding the new changes
There was a problem hiding this comment.
Done in 711000c — kept the MkDocs attributions and added Zensical alongside them:
@squidfunkline now credits both Material for MkDocs and Zensical- Kept the MkDocs project line (updated to past tense "that we used to build our docs")
- Added a new Zensical project line for the current tool
jamietanna
changed the title
|
A couple of other things not working:
Admonitions don't seem to be working: 
Code snippets don't look right ☝️ (no title?) |
…ttribution Co-authored-by: jamietanna <3315059+jamietanna@users.noreply.github.com>
Material for MkDocs 9.7.0 is the final release and the project has entered maintenance mode. Zensical is the official successor from the same developers, with maximum compatibility and an active development path.
Changes
Dependencies
pyproject.toml: Replacemkdocs-material==9.7.2+mkdocs-awesome-pages-plugin==2.10.1withzensical==0.0.23pdm.lock: Regenerated for new dependency treeConfiguration
tools/mkdocs/zensical.toml(new): TOML-format config preserving site metadata, repo info, custom theme dir, features, and palette; uses lucide icons for palette togglestools/mkdocs/mkdocs.yml(deleted): Replaced byzensical.tomltools/mkdocs/mkdocs-hooks/custom-edit-url.py: Retained — allows per-page override ofedit_urlvia YAML frontmatterBuild tooling
tools/mkdocs.ts: Callzensical build/zensical serveinstead ofmkdocs build/mkdocs servetools/generate-docs.ts: Update log messages.github/workflows/build.yml: Rename "Build mkdocs" steps to "Build docs site"Templates & docs
tools/mkdocs/overrides/: Update comments and copyright link to reference Zensicaldocs/usage/about-us.md: Keep MkDocs project attributions (past tense) and add new Zensical attributions alongside themdocs/development/local-development.md: Update docs tooling sectionNotes
awesome-pagesis unsupported in Zensical; navigation auto-generates from directory structure!ENVsupport, so the "These docs correspond to Mend Renovate X.Y.Z" note won't render (guarded by{% if config.extra.version %}so it degrades gracefully)tools/mkdocs/directory name is preserved to avoid touching all downstream build tooling referencesContext
AI assistance disclosure
Used GitHub Copilot coding agent to perform the migration: config conversion, dependency updates, template and documentation updates.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via:
Validated
zensical buildsucceeds against a minimal docs directory with the newzensical.tomlconfig.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.