diff options
-rw-r--r-- | doc/administration/img/integration/plantuml-example.png | bin | 12559 -> 0 bytes | |||
-rw-r--r-- | doc/administration/integration/plantuml.md | 11 |
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/administration/img/integration/plantuml-example.png b/doc/administration/img/integration/plantuml-example.png Binary files differdeleted file mode 100644 index 3e0d6389cbd..00000000000 --- a/doc/administration/img/integration/plantuml-example.png +++ /dev/null diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index fe0b392c2d7..c34f9f90e7c 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -95,7 +95,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: ~~~markdown ```plantuml Bob -> Alice : hello - Alice -> Bob : Go Away + Alice -> Bob : hi ``` ~~~ @@ -105,7 +105,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: [plantuml, format="png", id="myDiagram", width="200px"] ---- Bob->Alice : hello - Alice -> Bob : Go Away + Alice -> Bob : hi ---- ``` @@ -116,7 +116,7 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: :caption: Caption with **bold** and *italic* Bob -> Alice: hello - Alice -> Bob: Go Away + Alice -> Bob: hi ``` You can also use the `uml::` directive for compatibility with [sphinxcontrib-plantuml](https://pypi.org/project/sphinxcontrib-plantuml/), but please note that we currently only support the `caption` option. @@ -125,7 +125,10 @@ The above blocks will be converted to an HTML img tag with source pointing to th PlantUML instance. If the PlantUML server is correctly configured, this should render a nice diagram instead of the block: -![PlantUML Integration](../img/integration/plantuml-example.png) +```plantuml +Bob -> Alice : hello +Alice -> Bob : hi +``` Inside the block you can add any of the supported diagrams by PlantUML such as [Sequence](http://plantuml.com/sequence-diagram), [Use Case](http://plantuml.com/use-case-diagram), |