# sphinxcontrib-mermaid

[![](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml/badge.svg)](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml)
[![](https://img.shields.io/pypi/v/sphinxcontrib-mermaid)](https://pypi.org/project/sphinxcontrib-mermaid/)
[![](https://img.shields.io/pypi/dm/shbin)](https://libraries.io/pypi/sphinxcontrib-mermaid/)

This extension allows you to embed [Mermaid](https://mermaid.js.org/) graphs in your
documents, including general flowcharts, sequence diagrams, gantt diagrams and more.

See the [official Documentation](http://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/) or [project repository](https://github.com/mgaitan/sphinxcontrib-mermaid) for more details!
