kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'feature/plantuml-restructured-text' into 'master' 

Add documentation for PlantUML in reStructuredText

See merge request !13900
This commit is contained in:
Rémy Coutable 2017-09-07 14:45:03 +00:00
parent ba2b3121cd 21cf3d2c3f
commit 4bb1a3c159
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
changelogs/unreleased/feature-plantuml-restructured-text.yml Normal file
View File

@ -0,0 +1,5 @@
---
title: Add documentation for PlantUML in reStructuredText
merge_request: 13900
author: Markus Koller
type: other

11
doc/administration/integration/plantuml.md
View File

@ -71,6 +71,15 @@ And in Markdown using fenced code blocks:
Alice -> Bob : Go Away 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 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 PlantUML instance. If the PlantUML server is correctly configured, this should
render a nice diagram instead of the block: 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. Markdown does not support any parameters and will always use PNG format.
[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537 [ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537