README

This extension provides the #mermaid parser function to support the generation of diagrams and flowcharts with the help of the mermaid script language. Supported diagram forms include:

• Flowchart
• Sequence Diagram
• Class Diagram
• State Diagram
• Gantt Chart
• Pie Chart
• Entity Relationship Diagram
• Git Flow Chart
• User Journey Chart
• Quadrant Chart
• Requirement Diagram
• C4 Diagram
• Timeline Diagram
• Sankey Diagram
• XY Chart
• Block Diagram

Requirements

Requirements for Mermaid 6.x:

• PHP 7.4 or later
• MediaWiki 1.39 or later

You can use an older version of Mermaid for older versions of MediaWiki and/or PHP.

Installation and configuration

See the information on installing and configuring this extension.

Usage

See the information on using this extension.

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.

• File an issue
• Submit a pull request
• Ask a question on the mailing list

For developers

See the documention on how to update MermaidJS.

Tests

This extension provides unit and integration tests that are run by a continues integration platform but can also be executed using composer phpunit from the extension base directory.

License

GNU General Public License, version 2 or later.