Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation about WireViz #1650

Merged
merged 1 commit into from
Oct 2, 2023
Merged

Update documentation about WireViz #1650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,6 @@ A companion web server written in JavaScript (powered by _micro_) that provides
diagrams.net::
A companion web server written in JavaScript (powered by _micro_) that provides _diagrams.net_.

wireviz::
A companion web server written in Python (powered by _Flask_ and _Gunicorn_) that provides _WireViz_.

== Build

=== Gateway Server
Expand Down Expand Up @@ -146,9 +143,6 @@ Excalidraw
yuzutech/kroki-diagramsnet (experimental)::
diagrams.net

yuzutech/kroki-wireviz::
WireViz

You can use `docker-compose` to run multiple containers:

.docker-compose.yml
Expand All @@ -162,7 +156,6 @@ services:
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
- KROKI_WIREVIZ_HOST=wireviz
ports:
- "8000:8000"
mermaid:
Expand All @@ -182,10 +175,6 @@ services:
image: yuzutech/kroki-diagramsnet
expose:
- "8005"
wireviz:
image: yuzutech/kroki-wireviz
ports:
- "8006:8006"
----

$ docker-compose up -d
6 changes: 1 addition & 5 deletions docs/modules/setup/pages/install.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
:uri-docker-kroki-bpmn-image: https://hub.docker.com/r/yuzutech/kroki-bpmn
:uri-docker-kroki-excalidraw-image: https://hub.docker.com/r/yuzutech/kroki-excalidraw
:uri-docker-kroki-diagramsnet-image: https://hub.docker.com/r/yuzutech/kroki-diagramsnet
:uri-docker-kroki-wireviz-image: https://hub.docker.com/r/yuzutech/kroki-wireviz
// URIs of diagram generation application sites by diagram name
:uri-blockdiag: http://blockdiag.com/en/blockdiag/index.html
:uri-seqdiag: http://blockdiag.com/en/seqdiag/index.html
Expand Down Expand Up @@ -115,6 +114,7 @@ In other words, the following endpoints will be available:
/vega
/vegalite
/wavedrom
/wireviz
....

If you want to use additional diagram libraries (such as _BPMN_, _Excalidraw_ or _Mermaid_), then you will also need to start their companion containers:
Expand Down Expand Up @@ -142,7 +142,3 @@ Provides flowchart, sequence and Gantt diagrams for Kroki using the {uri-mermaid
[#yuzutech-kroki-diagramsnet]
{uri-docker-kroki-diagramsnet-image}[yuzutech/kroki-diagramsnet^] (experimental)::
Provides diagrams for Kroki using the {uri-diagramsnet}[diagrams.net^] library.

[#yuzutech-kroki-wireviz]
{uri-docker-kroki-wireviz-image}[yuzutech/kroki-wireviz^]::
Provides diagrams for Kroki using the {uri-wireviz}[WireViz^] library.