-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
improve mermaid and plantuml documentation
- Loading branch information
Showing
3 changed files
with
38 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Mermaid support | ||
|
||
[Mermaid](http://mermaid.js.org/) is a DSL for different types of diagrams. Notably, it can be written in GitHub Markdown documents and rendered automatically inline | ||
|
||
## Supported diagram types | ||
|
||
- :white_check_mark: [Flowchart](https://mermaid.js.org/syntax/flowchart.html#styling-and-classes) | ||
- :white_check_mark: Diagram direction | ||
- :white_check_mark: Node shapes | ||
- :white_check_mark: Links between nodes | ||
- :white_check_mark: Multi-source links | ||
- :white_check_mark: Chained links | ||
- :white_check_mark: Arrow styling | ||
- :white_check_mark: Subgraphs | ||
- :white_check_mark: Link styling | ||
- :white_check_mark: Node styling by ID |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# PlantUML support | ||
|
||
[PlantUML](https://plantuml.com/) is a DSL for different types of diagrams | ||
|
||
## Supported diagram types | ||
|
||
- :white_check_mark: [Sequence diagram](https://plantuml.com/sequence-diagram) | ||
|
||
## Viewing PlantUML | ||
|
||
### With Google Chrome | ||
|
||
Install the extension [PlantUML Viewer](https://chrome.google.com/webstore/detail/plantuml-viewer/legbfeljfbjgfifnkmpoajgpgejojooj?hl=en) | ||
|
||
When viewing on GitHub, be sure to access the "raw" version of the file (as plain text, outside of the GitHub UI) | ||
|
||
### With IntelliJ | ||
|
||
Install the plugin [PlantUML Integration](https://plugins.jetbrains.com/plugin/7017-plantuml-integration) |