mediawiki / mermaid
Provides a parser function to generate diagrams and charts with the help of the mermaid script language
Fund package maintenance!
Open Collective
www.semantic-mediawiki.org/wiki/Sponsorship
Installs: 44 955
Dependents: 1
Suggesters: 1
Security: 0
Stars: 36
Watchers: 16
Forks: 23
Open Issues: 24
Type:mediawiki-extension
Requires
- php: >=7.0.0
- composer/installers: 1.*,>=1.0.1
This package is auto-updated.
Last update: 2024-11-05 14:27:18 UTC
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
Requirements
Requirements for Mermaid 3.x:
- PHP 7.0 or later
- MediaWiki 1.33 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.