Skip to content

Commit

Permalink
chore(docs): add Ditaa diagram options to diagram-options page (#1781)
Browse files Browse the repository at this point in the history
Co-authored-by: Guillaume Grossetie <[email protected]>
  • Loading branch information
elbehery95 and ggrossetie authored Oct 21, 2024
1 parent 078989b commit 20af772
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ jobs:
run: ./kind delete cluster

test-dockercompose:
runs-on: ubuntu-22.04
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
Expand All @@ -110,7 +110,7 @@ jobs:
run: curl -fL https://download.docker.com/linux/static/stable/x86_64/docker-20.10.21.tgz | tar xzO docker/docker > docker && sudo mv -f docker /usr/bin/docker && sudo chmod +x /usr/bin/docker

- name: docker-compose up
run: docker-compose -f docs/modules/setup/examples/kroki-docker-compose.yml up -d
run: docker compose -f docs/modules/setup/examples/kroki-docker-compose.yml up -d

- name: Wait until available
run: |
Expand Down
36 changes: 35 additions & 1 deletion docs/modules/setup/pages/diagram-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,40 @@ empty string ("")
|Render diagram with a hand-drawn aesthetic: https://d2lang.com/tour/sketch/
|===

== Ditaa

[cols="1m,1a,2a",opts="header"]
|===
|Name
|Allowable Values
|Description

|no-antialias
|_any_ +
|Turns anti-aliasing off

|no-separation
|_any_ +
|Prevents the separation of common edges of shapes

|round-corners
|_any_ +
|Causes all corners to be rendered as round corners

|scale
|_double_ +
*`1.0`*
|A natural number that determines the size of the rendered image. The units are fractions of the default size (2.5 renders 1.5 times biggerthan the default)

|no-shadows
|_any_ +
|Turns off the drop-shadow effect

|tabs
|_any_ +
|Tabs are normally interpreted as 8 spaces but it is possible to change that using this option
|===

== GraphViz

[cols="1m,1a,2a",opts="header"]
Expand Down Expand Up @@ -291,4 +325,4 @@ empty string ("")
|Add name of a library to the diagram. +
Only works if title is also set

|===
|===

0 comments on commit 20af772

Please sign in to comment.