Skip to content

Commit

Permalink
improve mermaid and plantuml documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mcanlas committed Mar 22, 2024
1 parent 6f42d1e commit 3f47512
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 18 deletions.
21 changes: 3 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,10 @@
# temporal-diagrams
A Scala DSL for generating diagram variants

## Features (v2)
## Supported target languages

- Supports PlantUML
- Supports Mermaid
- Uses `cats` style encoding, derivation, and combinators

## 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)
- :white_check_mark: [Mermaid](docs/mermaid.md)
- :white_check_mark: [PlantUML](docs/plantuml.md)

## See also

Expand All @@ -43,6 +30,4 @@ PLANTUML_LIMIT_SIZE=8192 sbt run

## Elsewhere

- [Mermaid](http://mermaid.js.org/)
- [PlantUML](https://plantuml.com/)
- https://crashedmind.github.io/PlantUMLHitchhikersGuide/layout/layout.html
16 changes: 16 additions & 0 deletions docs/mermaid.md
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
19 changes: 19 additions & 0 deletions docs/plantuml.md
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)

0 comments on commit 3f47512

Please sign in to comment.