Commit 8f9b2fcc authored by Stan Hu's avatar Stan Hu

Document required quotes in Mermaid subgraph titles

Mermaid v8.2.3 added support for styling in subgraphs, but if there are
multiple words in a title, quotes are required.

* https://github.com/knsv/mermaid/pull/845
* https://github.com/knsv/mermaid/issues/391#issuecomment-495602059

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/65338
parent 2e7f4bbb
......@@ -185,6 +185,49 @@ graph TD;
C-->D;
```
#### Subgraphs
NOTE: **Note:** GitLab 12.1 and up now [requires quotes around subgraph
titles that contain multiple words](https://github.com/knsv/mermaid/pull/845).
Subgraphs can also be included:
~~~
```mermaid
graph TB
SubGraph1 --> SubGraph1Flow
subgraph "SubGraph 1 Flow"
SubGraph1Flow(SubNode 1)
SubGraph1Flow -- Choice1 --> DoChoice1
SubGraph1Flow -- Choice2 --> DoChoice2
end
subgraph "Main Graph"
Node1[Node 1] --> Node2[Node 2]
Node2 --> SubGraph1[Jump to SubGraph1]
SubGraph1 --> FinalThing[Final Thing]
end
```
~~~
```mermaid
graph TB
SubGraph1 --> SubGraph1Flow
subgraph "SubGraph 1 Flow"
SubGraph1Flow(SubNode 1)
SubGraph1Flow -- Choice1 --> DoChoice1
SubGraph1Flow -- Choice2 --> DoChoice2
end
subgraph "Main Graph"
Node1[Node 1] --> Node2[Node 2]
Node2 --> SubGraph1[Jump to SubGraph1]
SubGraph1 --> FinalThing[Final Thing]
end
```
### Emoji
> If this is not rendered correctly, [view it in GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#emoji).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment