diff options
Diffstat (limited to 'www/wiki/extensions/Mermaid/docs/INSTALL.md')
-rw-r--r-- | www/wiki/extensions/Mermaid/docs/INSTALL.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/www/wiki/extensions/Mermaid/docs/INSTALL.md b/www/wiki/extensions/Mermaid/docs/INSTALL.md new file mode 100644 index 00000000..9d65af40 --- /dev/null +++ b/www/wiki/extensions/Mermaid/docs/INSTALL.md @@ -0,0 +1,71 @@ +This file contains the *installation and configuration instructions* for the **Mermaid** extension. See also the +[readme], the [release notes] and [usage examples]. + +## Installation + +The recommended way to install this extension is using [Composer](http://getcomposer.org) with +[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer). + +### Step 1 + +Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php" +file is located. If you have not yet installed Composer do it now by running the following command +in your shell: + + wget https://getcomposer.org/composer.phar + +### Step 2 + +If you do not have a "composer.local.json" file yet, create one and add the following content to it: + +``` +{ + "require": { + "mediawiki/mermaid": "~2.1" + } +} +``` + +If you already have a "composer.local.json" file add the following line to the end of the "require" +section in your file: + + "mediawiki/mermaid": "~2.1" + +Remember to add a comma to the end of the preceding line in this section. + +### Step 3 + +Run the following command in your shell: + + php composer.phar update --no-dev + +Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also +note that it may be necessary to run this command twice. If unsure do it twice right away. + +### Step 4 + +Add the following line to the end of your "LocalSettings.php" file: + + wfLoadExtension( 'Mermaid' ); + +### Verify installation success + +As final step, you can verify Mermaid got installed by looking at the "Special:Version" page on your wiki and +check that it is listed. + +### Configuration + +One configuration parameter is provided allowing to choose the basic theme for rendereing the graphs, diagrams +and charts. By default the rendering is set to use the `forest` theme: + + $mermaidgDefaultTheme = 'forest'; + +If one would like to use one of the other themes provided (`default`, `neutral` or `dark`) the configuration +parameter can be set to it after invoking the extension, e.g.: + + wfLoadExtension( 'Mermaid' ); + $mermaidgDefaultTheme = 'neutral'; + +[readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md +[release notes]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/RELEASE-NOTES.md +[usage examples]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/USAGE.md |