beastbytes/mermaid

PHP for the Mermaid.js diagramming and charting tool.

dev-master 2025-12-20 13:24 UTC

Requires

• php: ^8.3

Requires (Dev)

• pestphp/pest: ^4.0
• roave/security-advisories: dev-latest
• vimeo/psalm: ^6.0

BSD-3-Clause

• Chris Yates

• charting
• mermaid
• diagramming

README

PHP for the Mermaid.js diagramming and charting tool.

For licence information see the LICENSE file.

Installation

This package is a dependency of, and so installed with, the various Mermaid charts and diagrams.

Usage

Call Mermaid::create(DiagramName::class) to get an instance of a diagram.

If creating a diagram that is in the BeastBytes\Mermaid namespace it can be created using the digram name. For example, Mermaid::create(Flowchart::class) and Mermaid::create('Flowchart') both return an instance of BeastBytes\Mermaid\Flowchart.

Mermaid::create() accepts an optional second argument; an associative array that specifies the Frontmatter for the diagram. For example Mermaid::create('Flowchart', ['title' => 'Example Flowchart]) specifies the title.

Configure the diagram as required - see the documentation for the diagram type for details, then call the diagram's render() method.