BigW Consortium Gitlab

Skip to content

G
gitlab-ce
Commit 4bb1a3c1 by Rémy Coutable
Options

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

Add documentation for PlantUML in reStructuredText See merge request !13900
parents ba2b3121 21cf3d2c
Showing with 15 additions and 2 deletions
changelogs/unreleased/feature-plantuml-restructured-text.yml 0 → 100644
---
title: Add documentation for PlantUML in reStructuredText
merge_request: 13900
author: Markus Koller
type: other
doc/administration/integration/plantuml.md
...@@ -71,6 +71,15 @@ And in Markdown using fenced code blocks: ...@@ -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: ...@@ -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
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment