@dskripchenko/diagrams 1.1.0 → 1.2.0

package/README.md

@@ -4,8 +4,8 @@
 [![npm](https://img.shields.io/npm/v/@dskripchenko/diagrams.svg)](https://www.npmjs.com/package/@dskripchenko/diagrams)
 [![license](https://img.shields.io/npm/l/@dskripchenko/diagrams.svg)](LICENSE)
 
-Diagrams written in Mermaid syntax, rendered to SVG — with **no runtime
-dependencies** and **no DOM**. A string goes in, a string of SVG comes out:
+Diagrams written as text — in **Mermaid** or **PlantUML** syntax — rendered
+to SVG, with **no runtime dependencies** and **no DOM**. A string goes in, a string of SVG comes out:
 the same call works in a browser, in server-side rendering and in a Node
 build script.
 
@@ -18,12 +18,24 @@ const { svg } = render(`flowchart LR
   B -->|no| D[Reject]`)
 
 element.innerHTML = svg
+
+// PlantUML: recognised by its @startuml.
+render(`@startuml
+actor User
+User -> API ++ : POST /orders
+return 201
+@enduml`)
 ```
 
 **Supported:** `flowchart` (with subgraphs and per-subgraph direction),
 `sequenceDiagram`, `stateDiagram-v2`, `erDiagram`, `classDiagram`, C4
 (`C4Context`, `C4Container`, `C4Component`, `C4Dynamic`, `C4Deployment`),
-`pie`, `gantt`, `timeline`, `xychart-beta`, `mindmap`.
+`pie`, `gantt`, `timeline`, `xychart-beta`, `mindmap`, `journey`,
+`quadrantChart`, `kanban`, `requirementDiagram`, `architecture-beta`,
+`sankey-beta`, `gitGraph`, `block-beta`; PlantUML sequence,
+use case, component, deployment, activity (with swimlanes), class, object,
+state, ER, C4 (C4-PlantUML) and timing diagrams, mind maps, WBS, Gantt
+charts and Salt wireframes.
 
 ## Why another renderer
 
@@ -42,7 +54,7 @@ element.innerHTML = svg
 - **Errors you can act on.** A source that cannot be read raises a
   `DiagramError` with the line, the column and, where there is one, a hint.
 
-The syntax is a declared subset of Mermaid's. What is supported is listed
+The syntax is a declared subset of Mermaid's and PlantUML's. What is supported is listed
 per diagram type in the documentation; anything else is an error rather
 than a silently wrong picture.
 
@@ -61,6 +73,15 @@ than a silently wrong picture.
 | Timeline | [en](docs/en/timeline.md) | [ru](docs/ru/timeline.md) | [de](docs/de/timeline.md) | [zh](docs/zh/timeline.md) |
 | XY chart | [en](docs/en/xychart.md) | [ru](docs/ru/xychart.md) | [de](docs/de/xychart.md) | [zh](docs/zh/xychart.md) |
 | Mind map | [en](docs/en/mindmap.md) | [ru](docs/ru/mindmap.md) | [de](docs/de/mindmap.md) | [zh](docs/zh/mindmap.md) |
+| Journey | [en](docs/en/journey.md) | [ru](docs/ru/journey.md) | [de](docs/de/journey.md) | [zh](docs/zh/journey.md) |
+| Quadrant chart | [en](docs/en/quadrant.md) | [ru](docs/ru/quadrant.md) | [de](docs/de/quadrant.md) | [zh](docs/zh/quadrant.md) |
+| Kanban board | [en](docs/en/kanban.md) | [ru](docs/ru/kanban.md) | [de](docs/de/kanban.md) | [zh](docs/zh/kanban.md) |
+| Requirement diagram | [en](docs/en/requirement.md) | [ru](docs/ru/requirement.md) | [de](docs/de/requirement.md) | [zh](docs/zh/requirement.md) |
+| Architecture diagram | [en](docs/en/architecture.md) | [ru](docs/ru/architecture.md) | [de](docs/de/architecture.md) | [zh](docs/zh/architecture.md) |
+| Sankey diagram | [en](docs/en/sankey.md) | [ru](docs/ru/sankey.md) | [de](docs/de/sankey.md) | [zh](docs/zh/sankey.md) |
+| Git graph | [en](docs/en/gitgraph.md) | [ru](docs/ru/gitgraph.md) | [de](docs/de/gitgraph.md) | [zh](docs/zh/gitgraph.md) |
+| Block diagram | [en](docs/en/block.md) | [ru](docs/ru/block.md) | [de](docs/de/block.md) | [zh](docs/zh/block.md) |
+| PlantUML | [en](docs/en/plantuml.md) | [ru](docs/ru/plantuml.md) | [de](docs/de/plantuml.md) | [zh](docs/zh/plantuml.md) |
 | Theming | [en](docs/en/theming.md) | [ru](docs/ru/theming.md) | [de](docs/de/theming.md) | [zh](docs/zh/theming.md) |
 
 ## Install