diff options
| -rw-r--r-- | changelogs/unreleased/feature-plantuml-restructured-text.yml | 5 | ||||
| -rw-r--r-- | doc/administration/integration/plantuml.md | 11 |
2 files changed, 15 insertions, 1 deletions
diff --git a/changelogs/unreleased/feature-plantuml-restructured-text.yml b/changelogs/unreleased/feature-plantuml-restructured-text.yml new file mode 100644 index 00000000000..b885029f589 --- /dev/null +++ b/changelogs/unreleased/feature-plantuml-restructured-text.yml @@ -0,0 +1,5 @@ +--- +title: Add documentation for PlantUML in reStructuredText +merge_request: 13900 +author: Markus Koller +type: other 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 |