diff options
| author | Douwe Maan <douwe@gitlab.com> | 2017-11-01 17:22:11 +0000 |
|---|---|---|
| committer | Douwe Maan <douwe@gitlab.com> | 2017-11-01 17:22:11 +0000 |
| commit | 45b756b27af13ddc74a7081d06280fda99d3ff66 (patch) | |
| tree | 5be94c24f98a32ed23f72c4a9a7bbd4c3606fb1b | |
| parent | 6ea9f0a33385e832c5a2525040f6916f120639e8 (diff) | |
| parent | fab06c980ae9f67f5a867caf07f37479ce99bc0e (diff) | |
| download | gitlab-ce-45b756b27af13ddc74a7081d06280fda99d3ff66.tar.gz | |
Merge branch 'feature/plantuml-restructured-text-captions' into 'master'
Update gitlab-markup and PlantUML docs
See merge request gitlab-org/gitlab-ce!15120
| -rw-r--r-- | Gemfile.lock | 2 | ||||
| -rw-r--r-- | changelogs/unreleased/feature-plantuml-restructured-text-captions.yml | 5 | ||||
| -rw-r--r-- | doc/administration/integration/plantuml.md | 37 |
3 files changed, 27 insertions, 17 deletions
diff --git a/Gemfile.lock b/Gemfile.lock index 4142977285e..8ccf18818a6 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -291,7 +291,7 @@ GEM diff-lcs (~> 1.1) mime-types (>= 1.16) posix-spawn (~> 0.3) - gitlab-markup (1.6.2) + gitlab-markup (1.6.3) gitlab_omniauth-ldap (2.0.4) net-ldap (~> 0.16) omniauth (~> 1.3) diff --git a/changelogs/unreleased/feature-plantuml-restructured-text-captions.yml b/changelogs/unreleased/feature-plantuml-restructured-text-captions.yml new file mode 100644 index 00000000000..3d8d0f4fcd1 --- /dev/null +++ b/changelogs/unreleased/feature-plantuml-restructured-text-captions.yml @@ -0,0 +1,5 @@ +--- +title: 'Support uml:: and captions in reStructuredText' +merge_request: 15120 +author: Markus Koller +type: changed diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index 652ca9cf454..93c3642a1f1 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -56,29 +56,34 @@ that, login with an Admin account and do following: With PlantUML integration enabled and configured, we can start adding diagrams to our AsciiDoc snippets, wikis and repos using delimited blocks: -``` -[plantuml, format="png", id="myDiagram", width="200px"] --- -Bob->Alice : hello -Alice -> Bob : Go Away --- -``` +- **Markdown** + + ```plantuml + Bob -> Alice : hello + Alice -> Bob : Go Away + ``` -And in Markdown using fenced code blocks: +- **AsciiDoc** - ```plantuml - Bob -> Alice : hello + ``` + [plantuml, format="png", id="myDiagram", width="200px"] + -- + Bob->Alice : hello Alice -> Bob : Go Away + -- ``` -And in reStructuredText using a directive: +- **reStructuredText** -``` -.. plantuml:: + ``` + .. plantuml:: + :caption: Caption with **bold** and *italic* - Bob -> Alice: hello - Alice -> Bob: Go Away -``` + Bob -> Alice: hello + Alice -> Bob: Go Away + ``` + + You can also use the `uml::` directive for compatibility with [sphinxcontrib-plantuml](https://pypi.python.org/pypi/sphinxcontrib-plantuml), but please note that we currently only support the `caption` option. 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 |