Skip to content

Commit

Permalink
Make 2.2.0 release (#43)
Browse files Browse the repository at this point in the history
* Update RELEASE-NOTES.md
** Fix compatibility information for the 2.1.0 release
** Adds information for the 2.2.0 release

* Update USAGE.md
** Add docu for the nee configuration parameter

* Update README.md
** Fix the information on the minimum required version

* Update extension.json
** Increment version
** Update minimum requirement
** Switch back to manifest 1 (let other figure out this magic)
  • Loading branch information
kghbln authored Mar 7, 2020
1 parent 5e564ef commit 9e4859b
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This extension provides the `#mermaid` parser function to support the generation
## Requirements

- PHP 5.6 or later
- MediaWiki 1.31 or later
- MediaWiki 1.33 or later

## Installation and configuration

Expand Down
8 changes: 7 additions & 1 deletion docs/RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
This file contains the *release notes* of the **Mermaid** extension. See also the
[readme], the [installation and configuration information] and [usage examples].

### 2.2.0

Released on March 7, 2020.

* Introcudes the flowchart useMaxWidth configuration parameter
* Translation updates from https://translatewiki.net

### 2.1.1

Expand All @@ -12,7 +18,7 @@ Released on May 20, 2019.

Released on March 5, 2019.

* Drops support for MediaWiki 1.30 and earlier
* Drops support for MediaWiki 1.32 and earlier
* Removes deprecated `mediawiki.api.parse` alias

### 2.0.0
Expand Down
21 changes: 21 additions & 0 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,29 @@ participant Bob
```
![image](https://user-images.githubusercontent.com/1245473/34535703-14a32100-f106-11e7-9201-ea90a6286c58.png)


Version 2.2.0 of this extension brought support for the flowchart useMaxWidth configuration parameter. It prevents
the respective chart from being resized to fit the size of the screen.

It is passed to the parser function like shown:
```
{{#mermaid:graph LR;
...
|
config.flowchart.useMaxWidth = false
}}
```
Note that is is also possible to further adapt the graph using CSS, e.g. to add a scrollbar:

```
.ext-mermaid > div {
overflow: scroll;
}
```

Further [examples][examplesmw] have been created on wiki.


[readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md
[mermaid]: https://github.com/knsv/mermaid
[examplemjs]: https://mermaidjs.github.io/
Expand Down
6 changes: 3 additions & 3 deletions extension.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Mermaid",
"version": "2.2.0-alpha",
"version": "2.2.0",
"author": [
"James Hong Kong"
],
Expand All @@ -9,7 +9,7 @@
"license-name": "GPL-2.0-or-later",
"type": "parserhook",
"requires": {
"MediaWiki": ">= 1.31"
"MediaWiki": ">= 1.33"
},
"MessagesDirs": {
"Mermaid": [
Expand All @@ -21,5 +21,5 @@
"Mermaid::onExtensionFunction"
],
"load_composer_autoloader": true,
"manifest_version": 2
"manifest_version": 1
}

0 comments on commit 9e4859b

Please sign in to comment.