.. Mermaid documentation master file, created by
   sphinx-quickstart on Tue Dec 30 21:09:45 2025.

Mermaid
=======

Mermaid allows creation of `Mermaid <https://mermaid.js.org>`__ charts and diagrams in PHP.

The Mermaid package is a dependency of Mermaid chart and diagram packages; see the chart packages for installation.

The Mermaid package provides:

* enums that are used in your code
* the Mermaid class that provides static functions used in your code
* the Diagram base class that all chart and diagrams extend
* traits that chart and diagrams use; the functions they provide are documented in the packages that use them

.. toctree::
   :maxdepth: 2
   :caption: Contents

   api