pypi / sphinxcontrib-mermaid
sphinxcontrib-mermaid
What changed in sphinxcontrib-mermaid 2, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-19.
1 new APIs and options1 performance10 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli initsphinxcontrib-mermaid 212 changes
New APIs and options 1
Adds an option for passing a global Mermaid configuration.
Performance 1
Loads the ZenUML plugin only on pages that contain a ZenUML diagram.
Fixes and other changes 10
Generated Mermaid caption nodes preserve source metadata so Sphinx can extract them into gettext catalogs and apply normal caption translations.
The HTML visitor passes the existing Mermaid image class through, making PNG output consistently targetable with CSS.
Fixes d3 zoom on nested SVGs.
Fixes fullscreen button positioning inconsistency.
Fixes interactions between the fullscreen, zoom, and lazy-render features.
Skips injecting Mermaid JavaScript when the output format does not support it.
Confines the injected ZenUML stylesheet to the diagram subtree so it no longer restyles the host theme.
Root-level pages now use a valid relative ES module specifier for local JS module imports.
Diagrams hidden by a parent are rendered when they become visible, fixing broken SVGs.
mmdc error messages are captured as strings for nicer error display.