diff options
Diffstat (limited to 'www/wiki/extensions/Mermaid/README.md')
-rw-r--r-- | www/wiki/extensions/Mermaid/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/www/wiki/extensions/Mermaid/README.md b/www/wiki/extensions/Mermaid/README.md new file mode 100644 index 00000000..1031f5b5 --- /dev/null +++ b/www/wiki/extensions/Mermaid/README.md @@ -0,0 +1,52 @@ +# Mermaid + +[![Build Status](https://secure.travis-ci.org/SemanticMediaWiki/Mermaid.svg?branch=master)](http://travis-ci.org/SemanticMediaWiki/Mermaid) +[![Latest Stable Version](https://poser.pugx.org/mediawiki/mermaid/version.png)](https://packagist.org/packages/mediawiki/mermaid) +[![Packagist download count](https://poser.pugx.org/mediawiki/mermaid/d/total.png)](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 + |