Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Koller <markus-koller@gmx.ch>2017-08-29 17:04:32 +0300
committerMarkus Koller <markus-koller@gmx.ch>2017-08-29 17:09:46 +0300
commit21cf3d2c3f39de8069c404932733068c3100a279 (patch)
tree981f0a058697e9a3241a7f5fe830282e959806c9 /doc/administration/integration
parented1ca47c9ea893d643ae613f39b65d80db3b0e67 (diff)
Add documentation for PlantUML in reStructuredText
Diffstat (limited to 'doc/administration/integration')
-rw-r--r--doc/administration/integration/plantuml.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md
index b21817c1fd3..652ca9cf454 100644
--- a/doc/administration/integration/plantuml.md
+++ b/doc/administration/integration/plantuml.md
@@ -71,6 +71,15 @@ And in Markdown using fenced code blocks:
Alice -> Bob : Go Away
```
+And in reStructuredText using a directive:
+
+```
+.. plantuml::
+
+ Bob -> Alice: hello
+ Alice -> Bob: Go Away
+```
+
The above blocks will be converted to an HTML img tag with source pointing to the
PlantUML instance. If the PlantUML server is correctly configured, this should
render a nice diagram instead of the block:
@@ -94,4 +103,4 @@ Some parameters can be added to the AsciiDoc block definition:
Markdown does not support any parameters and will always use PNG format.
-[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537 \ No newline at end of file
+[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537