mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-09 17:19:45 +02:00
Tidy up documentation, correct rendering in test
This commit is contained in:
15
README.md
15
README.md
@@ -12,7 +12,7 @@ __mermaid is a Javascript based diagramming and charting tool. It generates diag
|
|||||||
Check out the list of [Integrations and Usages of Mermaid](https://github.com/mermaid-js/mermaid/blob/develop/docs/integrations.md)
|
Check out the list of [Integrations and Usages of Mermaid](https://github.com/mermaid-js/mermaid/blob/develop/docs/integrations.md)
|
||||||
|
|
||||||
For more information and help in getting started, please view our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Alternatively, you can also play with our [live editor](https://mermaidjs.github.io/mermaid-live-editor/).
|
For more information and help in getting started, please view our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Alternatively, you can also play with our [live editor](https://mermaidjs.github.io/mermaid-live-editor/).
|
||||||
<!-- </Main description> -->
|
<!-- </Main description> -->
|
||||||
|
|
||||||
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.**
|
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.**
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ Crash --> [*]
|
|||||||
pie
|
pie
|
||||||
"Dogs" : 386
|
"Dogs" : 386
|
||||||
"Cats" : 85
|
"Cats" : 85
|
||||||
"Rats" : 15
|
"Rats" : 15
|
||||||
</pre></td>
|
</pre></td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-pie.png" />
|
<img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-pie.png" />
|
||||||
@@ -187,8 +187,13 @@ pie
|
|||||||
</tr>
|
</tr>
|
||||||
<!-- </Git> -->
|
<!-- </Git> -->
|
||||||
<!-- <Journey> -->
|
<!-- <Journey> -->
|
||||||
|
<tr><td colspan=2 align="center">
|
||||||
|
<b>User Journey</b><br />
|
||||||
|
[<a href="http://mermaid-js.github.io/mermaid/#/userJourney">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtXG4gICAgWypdIC0tPiBTdGlsbFxuICAgIFN0aWxsIC0tPiBbKl1cbiAgICBTdGlsbCAtLT4gTW92aW5nXG4gICAgTW92aW5nIC0tPiBTdGlsbFxuICAgIE1vdmluZyAtLT4gQ3Jhc2hcbiAgICBDcmFzaCAtLT4gWypdIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
|
||||||
|
</td></tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><pre>
|
<td>
|
||||||
|
<pre>
|
||||||
journey
|
journey
|
||||||
title Hello
|
title Hello
|
||||||
section Go to work
|
section Go to work
|
||||||
@@ -200,14 +205,14 @@ pie
|
|||||||
Sit down: 3: Me
|
Sit down: 3: Me
|
||||||
</pre></td>
|
</pre></td>
|
||||||
<td align="center">
|
<td align="center">
|
||||||
<img alt="User Journey Diagram" src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-journey.png" />
|
<img alt="User Journey Diagram" src="img/user-journey.png" />
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<!-- </Journey> -->
|
<!-- </Journey> -->
|
||||||
|
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
## Related projects
|
## Related projects
|
||||||
|
|
||||||
- [Command Line Interface](https://github.com/mermaid-js/mermaid.cli)
|
- [Command Line Interface](https://github.com/mermaid-js/mermaid.cli)
|
||||||
- [Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
|
- [Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
|
||||||
|
@@ -16,16 +16,14 @@ section Order from website
|
|||||||
imgSnapshotTest(
|
imgSnapshotTest(
|
||||||
`
|
`
|
||||||
journey
|
journey
|
||||||
title Go shopping
|
title My working day
|
||||||
|
section Go to work
|
||||||
section Get to the shops
|
Make tea: 5: Me
|
||||||
Get car keys: Dad
|
Go upstairs: 3: Me
|
||||||
Get into car: Dad, Mum, Child#1, Child#2
|
Do work: 1: Me, Cat
|
||||||
Drive to supermarket: Dad
|
section Go home
|
||||||
|
Go downstairs: 5: Me
|
||||||
section Do shopping
|
Sit down: 3: Me
|
||||||
Do actual shop: Mum
|
|
||||||
Get in the way: Dad, Child#1, Child#2
|
|
||||||
`,
|
`,
|
||||||
{}
|
{}
|
||||||
);
|
);
|
||||||
|
@@ -209,6 +209,41 @@ This will display arrows that start and begin at the same node as right angles,
|
|||||||
This will show the node numbers
|
This will show the node numbers
|
||||||
**Default value false**.
|
**Default value false**.
|
||||||
|
|
||||||
|
### actorFontSize
|
||||||
|
|
||||||
|
This sets the font size of the actor's description
|
||||||
|
**Default value 14**.
|
||||||
|
|
||||||
|
### actorFontFamily
|
||||||
|
|
||||||
|
This sets the font family of the actor's description
|
||||||
|
**Default value "Open-Sans", "sans-serif"**.
|
||||||
|
|
||||||
|
### noteFontSize
|
||||||
|
|
||||||
|
This sets the font size of actor-attached notes.
|
||||||
|
**Default value 14**.
|
||||||
|
|
||||||
|
### noteFontFamily
|
||||||
|
|
||||||
|
This sets the font family of actor-attached notes.
|
||||||
|
**Default value "trebuchet ms", verdana, arial**.
|
||||||
|
|
||||||
|
### noteAlign
|
||||||
|
|
||||||
|
This sets the text alignment of actor-attached notes.
|
||||||
|
**Default value center**.
|
||||||
|
|
||||||
|
### messageFontSize
|
||||||
|
|
||||||
|
This sets the font size of actor messages.
|
||||||
|
**Default value 16**.
|
||||||
|
|
||||||
|
### messageFontFamily
|
||||||
|
|
||||||
|
This sets the font family of actor messages.
|
||||||
|
**Default value "trebuchet ms", verdana, arial**.
|
||||||
|
|
||||||
## gantt
|
## gantt
|
||||||
|
|
||||||
The object containing configurations specific for gantt diagrams\*
|
The object containing configurations specific for gantt diagrams\*
|
||||||
@@ -263,6 +298,80 @@ The number of alternating section styles.
|
|||||||
Datetime format of the axis. This might need adjustment to match your locale and preferences
|
Datetime format of the axis. This might need adjustment to match your locale and preferences
|
||||||
**Default value '%Y-%m-%d'**.
|
**Default value '%Y-%m-%d'**.
|
||||||
|
|
||||||
|
## journey
|
||||||
|
|
||||||
|
The object containing configurations specific for sequence diagrams
|
||||||
|
|
||||||
|
### diagramMarginX
|
||||||
|
|
||||||
|
margin to the right and left of the sequence diagram.
|
||||||
|
**Default value 50**.
|
||||||
|
|
||||||
|
### diagramMarginY
|
||||||
|
|
||||||
|
margin to the over and under the sequence diagram.
|
||||||
|
**Default value 10**.
|
||||||
|
|
||||||
|
### actorMargin
|
||||||
|
|
||||||
|
Margin between actors.
|
||||||
|
**Default value 50**.
|
||||||
|
|
||||||
|
### width
|
||||||
|
|
||||||
|
Width of actor boxes
|
||||||
|
**Default value 150**.
|
||||||
|
|
||||||
|
### height
|
||||||
|
|
||||||
|
Height of actor boxes
|
||||||
|
**Default value 65**.
|
||||||
|
|
||||||
|
### boxMargin
|
||||||
|
|
||||||
|
Margin around loop boxes
|
||||||
|
**Default value 10**.
|
||||||
|
|
||||||
|
### boxTextMargin
|
||||||
|
|
||||||
|
margin around the text in loop/alt/opt boxes
|
||||||
|
**Default value 5**.
|
||||||
|
|
||||||
|
### noteMargin
|
||||||
|
|
||||||
|
margin around notes.
|
||||||
|
**Default value 10**.
|
||||||
|
|
||||||
|
### messageMargin
|
||||||
|
|
||||||
|
Space between messages.
|
||||||
|
**Default value 35**.
|
||||||
|
|
||||||
|
### messageAlign
|
||||||
|
|
||||||
|
Multiline message alignment. Possible values are:
|
||||||
|
|
||||||
|
- left
|
||||||
|
- center **default**
|
||||||
|
- right
|
||||||
|
|
||||||
|
### bottomMarginAdj
|
||||||
|
|
||||||
|
Depending on css styling this might need adjustment.
|
||||||
|
Prolongs the edge of the diagram downwards.
|
||||||
|
**Default value 1**.
|
||||||
|
|
||||||
|
### useMaxWidth
|
||||||
|
|
||||||
|
when this flag is set the height and width is set to 100% and is then scaling with the
|
||||||
|
available space if not the absolute space required is used.
|
||||||
|
**Default value true**.
|
||||||
|
|
||||||
|
### rightAngles
|
||||||
|
|
||||||
|
This will display arrows that start and begin at the same node as right angles, rather than a curve
|
||||||
|
**Default value false**.
|
||||||
|
|
||||||
## er
|
## er
|
||||||
|
|
||||||
The object containing configurations specific for entity relationship diagrams
|
The object containing configurations specific for entity relationship diagrams
|
||||||
|
BIN
img/user-journey.png
Normal file
BIN
img/user-journey.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 39 KiB |
Reference in New Issue
Block a user