Metadata-Version: 2.5
Name: sphinxcontrib-mermaid
Version: 3.0.0a1
Summary: Mermaid diagrams in your Sphinx-powered docs
Project-URL: Repository, https://github.com/mgaitan/sphinxcontrib-mermaid
Project-URL: Homepage, https://github.com/mgaitan/sphinxcontrib-mermaid
Project-URL: Changelog, https://github.com/mgaitan/sphinxcontrib-mermaid/blob/master/CHANGELOG.md
Author-email: Martín Gaitán <gaitan@gmail.com>
License-Expression: BSD-2-Clause
License-File: LICENSE
Keywords: diagrams,documentation,mermaid,sphinx
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: packaging
Requires-Dist: pyyaml
Requires-Dist: sphinx>=7.4
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: defusedxml; extra == 'develop'
Requires-Dist: furo; extra == 'develop'
Requires-Dist: hatch-js; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-frontmatter; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: myst-parser; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: types-docutils; extra == 'develop'
Requires-Dist: types-pyyaml; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# sphinxcontrib-mermaid

[![build status](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/build.yaml/badge.svg)](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/build.yaml)
[![version](https://img.shields.io/pypi/v/sphinxcontrib-mermaid)](https://pypi.org/project/sphinxcontrib-mermaid/)
[![downloads](https://img.shields.io/pypi/dm/sphinxcontrib-mermaid)](https://libraries.io/pypi/sphinxcontrib-mermaid/)

Embed [Mermaid](https://mermaid.js.org/) diagrams in Sphinx documents. HTML
pages render diagrams in the browser with a bundled copy of Mermaid, sized to
keep text readable, with pan, zoom, and a fullscreen view. LaTeX, texinfo, and
static image output use [mermaid-cli](https://github.com/mermaid-js/mermaid-cli).

## Install

```sh
pip install sphinxcontrib-mermaid
```

```python
# conf.py
extensions = ["sphinxcontrib.mermaid"]
```

## Use

```rst
.. mermaid::
   :caption: Publishing flow

   flowchart LR
       Draft --> Review --> Published
```

In Markdown with [MyST](https://myst-parser.readthedocs.io/), use a
```` ```{mermaid} ```` fence, or set `myst_fence_as_directive = ["mermaid"]` to render
plain ```` ```mermaid ```` fences. Diagrams can also come from `.mmd` files:
`.. mermaid:: diagrams/release.mmd`.

Size and interaction options work as directive options or in the diagram's
frontmatter:

```text
---
title: Release
height: 400px
config:
  layout: elk
---
flowchart TD
    Tag --> Build --> Publish
```

## Documentation

- [Tutorial](docs/src/tutorial.md)
- [Configuration reference](docs/src/configuration.md)
- [Upgrading from 2.x](docs/src/migration.md)
- [Diagram gallery](docs/src/examples.md)
