Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
903ab252
Commit
903ab252
authored
May 16, 2021
by
Guillaume Grossetie
Committed by
Douglas Barbosa Alexandre
May 19, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update Kroki documentation about rSt and Textile
parent
fa4b1772
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
3 deletions
+20
-3
doc/administration/integration/kroki.md
doc/administration/integration/kroki.md
+20
-3
No files found.
doc/administration/integration/kroki.md
View file @
903ab252
...
...
@@ -6,10 +6,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Kroki diagrams **(FREE SELF)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241744) in GitLab 13.7.
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241744) in GitLab 13.7.
> - Support for reStructuredText and Textile documents [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/324766) in GitLab 13.12.
When
[
Kroki
](
https://kroki.io
)
integration is enabled and configured in
GitLab you can use it to create diagrams in AsciiDoc
and Markdown
documents.
GitLab you can use it to create diagrams in AsciiDoc
, Markdown, reStructuredText and Textile
documents.
## Kroki Server
...
...
@@ -85,13 +86,29 @@ your AsciiDoc or Markdown documentation using delimited blocks:
....
```
-
**reStructuredText**
```
plaintext
.. code-block:: plantuml
Bob->Alice : hello
Alice -> Bob : hi
```
-
**Textile**
```
plaintext
bc[plantuml]. Bob->Alice : hello
Alice -> Bob : hi
```
The above blocks are converted to an HTML image tag with source pointing to the
Kroki instance. If the Kroki server is correctly configured, this should
render a nice diagram instead of the block:
![
PlantUML diagram
](
../img/kroki_plantuml_diagram.png
)
Kroki supports more than a dozen diagram libraries. Here's a few examples:
Kroki supports more than a dozen diagram libraries. Here's a few examples
for AsciiDoc
:
**GraphViz**
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment