bauglir/Kroki.jl

mermaid not working

guilhermebodin opened this issue · 2 comments

I am having trouble building some documentation that relied on Kroki to render the diagrams.

https://github.com/psrenergy/PSRClassesInterface.jl/actions/runs/7118845881/job/19382649359

This is a bad request somewhere. Anybody happens to know how to fix this?

It does not work in the kroki website
image

Hi Guilherme! I can reproduce this not working on the Kroki website as well. Unfortunately, that means there is not too much that I can do to alleviate this. This package is just a simple wrapper around the Kroki service hosted on https://kroki.io. In this case it's best to raise this directly with the people hosting the service. Likely through their Zulip chat which already has a few threads12 regarding this subject that were active yesterday.

One alternative, that's been on my to-do list to write up for a long time but hasn't bubbled to the top just yet, is to use a locally hosted version of Kroki. See also #43. If you have Docker Compose installed within your CI environment, you can use the Kroki.Service.start! function to start a locally running service (for instance in your docs/make.jl). After that has been called the package will automatically use that version by default.

Footnotes

  1. https://kroki.zulipchat.com/#narrow/stream/232085-users/topic/.E2.9C.94.20kroki.20mermaid.20failing

  2. https://kroki.zulipchat.com/#narrow/stream/232085-users/topic/kroki.2Eio.20returns.20400.20on.20Mermaid.20diagrams