search

asciidoctor / asciidoctor-kroki

Asciidoctor.js extension to convert diagrams to images using Kroki!
https://kroki.io/
MIT License
146 stars 47 forks source link

Better documentation around passing options to Kroki #449

Open jaskij opened 2 months ago

jaskij commented 2 months ago

I came here to open an issue similar to #418. Reading through the comments under it, specifically https://github.com/asciidoctor/asciidoctor-kroki/issues/418#issuecomment-2039249262, it turns out that unknown named attributes are just passed through to Kroki as diagram options.

Perhaps this is present in the README, but never stated explicitly.

ggrossetie commented 2 months ago

I came here to open an issue similar to https://github.com/asciidoctor/asciidoctor-kroki/issues/418. Reading through the comments under it, specifically https://github.com/asciidoctor/asciidoctor-kroki/issues/418#issuecomment-2039249262, it turns out that unknown named attributes are just passed through to Kroki as diagram options.

Perhaps this is present in the README, but never stated explicitly.

I agree, we should add this information. Feel free to open a pull request to add a section about it in the README.