PlantUML support

[ben-ole]

How is it about integrating plantUML to easily support UML diagrams in markdown sections?

[EvilClay]

+1

[johnfairh]

Can you say a bit more about your use cases here? Are you imagining using this in doc comments or the separate markdown documents? Would you want jazzy to include the actual image files in its docs or just link to the plantuml [or wherever] webservice from its pages? Why / Why not?

[hirohitokato]

+1

[tintinesand]

We have included some plantuml graphs in jazzy doc by manually and wonder how can intergate jazzy with plantuml so we can build doc with plantuml images by only one command.

I presume two ways look ok to me:

1. add plantuml scripts into comment and replace them with images generated by plantuml tools when building jazzy doc;
2. add plantuml script files link in comment and let jazzy can generate plantuml images by reading the linked file.

I perfer the second way because developer can edit plantuml scripts seperately.

Would you give us any advice to implement this feature by ourselves.

[EvilClay]

I would start with the first option, and then add the second. Why not have both, should not be that difficult once one of the exists.

[johnfairh]

Jazzy doesn't have great support for including resources like images in the site, you have to do it manually as you've found. #853 is about fixing this, I added some comments there on a sketch of a design.

First option above - something like hooking block_code in the markdown renderer, spot a language of 'plantuml' or something, do the rendering, add the image file to the #853 infrastructure, and return some html that is the <img> tag for the image.

Second option you could pick a different markdown syntax to hook or use the same.

That said I'm not personally convinced yet that it makes sense to embed special support for plantuml in jazzy - lots of other ways of drawing pictures. If your preferred approach is option 2 then jazzy ends up just running a script -- may as well just push that into a makefile/whatever and give jazzy the resulting image.

edit: came out more negative than I feel! The inline plantuml document does sound neat.

[TaborKelly]

Just as a point of reference Doxygen has support today for generating the images and including them in the final html/pdf/whatever.
http://www.doxygen.nl/manual/commands.html#cmdstartuml

I haven't taken the time to dig into Jazzy but I too would love this feature.

[jpsim]

I haven't taken the time to dig into Jazzy but I too would love this feature.

Sounds like a great opportunity to dig into it 😉