Skip to content

Migrate documentation from MkDocs to Zensical #279

Description

@corentin-core

Context

MkDocs is experiencing a leadership crisis: maintainer conflicts, stalled development (no release since August 2024), and a proposed v2 that removes plugin support entirely — which would break the Material theme we rely on.

Zensical, built by the Material for MkDocs team, is the natural successor. It reads existing mkdocs.yml files natively and builds 5x faster.

Reference: https://fpgmaas.com/blog/collapse-of-mkdocs/

Proposed solution

  • Replace mkdocs with zensical in dependencies
  • Verify the documentation builds correctly with Zensical (themes, Mermaid diagrams, pymdownx extensions)
  • Adapt mkdocs.yml if any breaking changes exist
  • Update CI/CD pipeline if applicable

Acceptance criteria

  • Zensical installed and building the docs successfully
  • All pages render correctly (navigation, code blocks, Mermaid diagrams, admonitions)
  • mkdocs.yml updated if needed
  • Dependencies updated in setup.cfg

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions