Merge branch 'feature/plantuml-restructured-text' into 'master'
Add documentation for PlantUML in reStructuredText See merge request !13900
This commit is contained in:
commit
4bb1a3c159
2 changed files with 15 additions and 1 deletions
|
@ -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
|
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:
|
||||||
|
|
Loading…
Reference in a new issue