Add documentation for PlantUML in reStructuredText
This commit is contained in:
parent
ed1ca47c9e
commit
21cf3d2c3f
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Add documentation for PlantUML in reStructuredText
|
||||
merge_request: 13900
|
||||
author: Markus Koller
|
||||
type: other
|
|
@ -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
|
||||
[ce-8537]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8537
|
||||
|
|
Loading…
Reference in New Issue