sphinxcontrib-mermaid
Mermaid diagrams in your Sphinx-powered docs
Decision gist · record as of 2026-08-14
Yes. The package is actively maintained, has low install friction, carries no known vulnerabilities, uses a permissive license, and solves a clear documentation need. It is well-suited for any Sphinx-based project that benefits from embedded diagrams. Install it if you are using Sphinx and want to include Mermaid diagrams without managing separate image files.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; Sphinx must be installed and configured in your documentation project.
- Low install friction with three straightforward runtime dependencies.
- Actively maintained with a recent release 27 days ago and ongoing commits; the repository has 409 stars and is not archived.
License · maintenance · safety
BSD-2-Clause (permissive) — BSD-2-Clause is permissive, allowing commercial and private use with minimal restrictions beyond retaining the license notice.
last release 2026-07-18 (27 days) · last repo commit 2026-08-03 · 409 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 6,384,596 downloads/mo, #1,918 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-mermaid
# In conf.py:
extensions = ['sphinxcontrib.mermaid']
# In your .rst file:
.. mermaid::
graph LR
A --> B- Whether Mermaid JavaScript library is automatically bundled or requires separate installation in the build environment.
- Support for all Mermaid diagram types (e.g., state diagrams, class diagrams, entity-relationship diagrams) beyond those mentioned in the description.
What it is and what it does
sphinxcontrib-mermaid is a Sphinx extension that lets you write Mermaid diagram syntax directly in your reStructuredText or Markdown documentation and have them render as interactive diagrams in the final HTML output. It integrates with Sphinx's build pipeline and depends on Jinja2, PyYAML, and Sphinx itself to process and embed the diagrams.
The extension is useful when you want to include flowcharts, sequence diagrams, Gantt charts, and other visual representations in technical documentation without manually creating image files. You write the diagram definition in plain text using Mermaid's syntax, and the extension handles conversion to rendered graphics during the Sphinx build.
Use it for
- Add flowcharts and process diagrams to API documentation or architecture guides.
- Include sequence diagrams in technical specifications or protocol documentation.
- Embed Gantt charts in project planning or timeline documentation.
- Create state machine diagrams for explaining system behavior or workflows.
- Build interactive diagrams that render consistently across all documentation builds.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The package is actively maintained, has low install friction, carries no known vulnerabilities, uses a permissive license, and solves a clear documentation need. It is well-suited for any Sphinx-based project that benefits from embedded diagrams. Install it if you are using Sphinx and want to include Mermaid diagrams without managing separate image files.
Install
sphinxcontrib-mermaid on PyPI
Before you install
Low install friction with three straightforward runtime dependencies. Actively maintained with a recent release 27 days ago and ongoing commits; the repository has 409 stars and is not archived.
Requires Python 3.10 or later; Sphinx must be installed and configured in your documentation project.
License in practice
BSD-2-Clause is permissive, allowing commercial and private use with minimal restrictions beyond retaining the license notice.
Quickstart
pip install sphinxcontrib-mermaid
# In conf.py:
extensions = ['sphinxcontrib.mermaid']
# In your .rst file:
.. mermaid::
graph LR
A --> BVerify before relying
- Whether Mermaid JavaScript library is automatically bundled or requires separate installation in the build environment.
- Support for all Mermaid diagram types (e.g., state diagrams, class diagrams, entity-relationship diagrams) beyond those mentioned in the description.
Package facts
| License | BSD-2-Clause permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesjinja2pyyamlsphinx |
| Maintenance | Actively maintained 27 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 6,384,596 / month, #1,918 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaEnvironment :: ConsoleEnvironment :: Web EnvironmentFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: DocumentationTopic :: Utilities |
Evidence: sphinxcontrib_mermaid-2.1.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx mermaid diagrams”
- sphinxcontrib-mermaidEmbeds Mermaid diagrams (flowcharts, sequence diagrams, Gantt charts,…
- mkdocs-mermaid2-pluginA MkDocs plugin that renders Mermaid diagram syntax embedded in…
- mermaid-pymermaid-py provides a Python interface to the Mermaid diagram…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also mermaid-py · mkdocs-mermaid2-plugin · sphinxcontrib-blockdiag · paracelsus · mermaid-builder · django-diagram · mkdocs-panzoom-plugin · sphinxcontrib-plantuml · sphinx-comments · sphinx-plotly-directive