mediawiki/mermaid
Provides a parser function to generate diagrams and charts with the help of the mermaid script language
Package info
github.com/SemanticMediaWiki/Mermaid
Type:mediawiki-extension
pkg:composer/mediawiki/mermaid
Requires
- php: >=7.4
- composer/installers: ^2.2.0|^1.0.1
Requires (Dev)
Suggests
None
Provides
None
Conflicts
None
Replaces
None
GPL-2.0-or-later bc7363f003057888b2f0087f350fd63c172afb05
- James Hong Kong
- Tyler Gibson
README
👁 CI
👁 codecov
👁 Latest Stable Version
👁 Packagist download count
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 8.1 or later
- MediaWiki 1.43 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.