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.

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

embedding plantUML diagrams #55

Open
abdelhalim opened this issue Mar 10, 2024 · 2 comments
Open

embedding plantUML diagrams #55

abdelhalim opened this issue Mar 10, 2024 · 2 comments

Comments

@abdelhalim
Copy link

Is there a way to embed plantUML diagrams in the comments ?

@yinzara
Copy link
Contributor

yinzara commented Mar 21, 2024

You could use the protoc-gen-uml protobuf plugin to generate the UML into the static directory then link to it from your main content page.

@markvincze
Copy link
Owner

@abdelhalim Not at the moment. I'm not very familiar with PlantUML, do I see it correctly that the way to generate the diagram images from the markup is to use the CLI which depends on Java?
I see that there is an extension for python-markdown which gives PlantUML support: https://pypi.org/project/plantuml-markdown/, but this also requires the PlantUML binary and Java to be installed as far as I see.
I could imagine this being supported as an optional extension, but I'd need to look into it in more detail, which I'm not sure when I could get to.

In the meantime, the solution you can use is what yinzara advised, to generate the UML diagrams outside of sabledocs, and put the generated images in static. Although I don't know if you'll be able to embed images in the comments, I've only tested that on the main page content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants