blob: 1031f5b5bc4d9f4152c5c83d57fbeaf63aa0ca3f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# Mermaid
[](http://travis-ci.org/SemanticMediaWiki/Mermaid)
[](https://packagist.org/packages/mediawiki/mermaid)
[](https://packagist.org/packages/mediawiki/mermaid)
This extension provides the `#mermaid` parser function to support the generation of diagrams and flowcharts with the help of the [mermaid][mermaid] script language. Supported diagram forms include:
- Flowchart
- Sequence diagram
- Gantt diagram
## Requirements
- PHP 5.6 or later
- MediaWiki 1.31 or later
## 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](https://github.com/SemanticMediaWiki/Mermaid/issues)
* [Submit a pull request](https://github.com/SemanticMediaWiki/Mermaid/pulls)
* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
* Ask a question on the #semantic-mediawiki IRC channel on Freenode.
## Tests
This extension provides unit and integration tests that are run by a [continues integration platform][travis]
but can also be executed using `composer phpunit` from the extension base directory.
## License
[GNU General Public License, version 2 or later][gpl-licence].
[gpl-licence]: https://www.gnu.org/copyleft/gpl.html
[travis]: https://travis-ci.org/SemanticMediaWiki/Mermaid
[smw]: https://github.com/SemanticMediaWiki/SemanticMediaWiki
[composer]: https://getcomposer.org/
[mermaid]: https://github.com/knsv/mermaid
[installing and configuring]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/INSTALL.md
[using]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/USAGE.md
|
