docs: migrate from MkDocs/Material for MkDocs to Zensical#110
Merged
Conversation
MkDocs is being deprecated. Zensical is the recommended replacement by the Material for MkDocs team, with drop-in mkdocs.yml compatibility. - Migrate CI from mkdocs-material to Zensical (pinned v0.0.46) - Replace mkdocs gh-deploy with zensical build + peaceiris/actions-gh-pages - Update AGENTS.md references from mkdocs to zensical - Add ADR-0001 documenting the decision
Contributor
🦙 MegaLinter status:
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ HTML | htmlhint | 1 | 0 | 0 | 0.6s | |
| standard | 2 | 2 | 1 | 0 | 2.24s | |
| ✅ KOTLIN | detekt | yes | no | no | 3.74s | |
| ✅ MARKDOWN | markdown-table-formatter | 26 | 7 | 0 | 0 | 0.45s |
| ✅ YAML | prettier | 15 | 7 | 0 | 0 | 0.96s |
See detailed report in MegaLinter reports
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
1 participant
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
Migrate the documentation toolchain from MkDocs + Material for MkDocs to Zensical, the recommended replacement by the Material for MkDocs team. MkDocs is being deprecated, and Zensical offers drop-in compatibility with existing
mkdocs.ymlconfiguration.Key changes:
zensical==0.0.46(pinned) instead ofmkdocs-materialzensical build+peaceiris/actions-gh-pagesinstead ofmkdocs gh-deployChanged Files
.github/workflows/documentation.yml— CI pipeline (install, cache, deploy steps)AGENTS.md— local serve command and workflow descriptiondocs/adr/0001-migrate-to-zensical.md— new ADR