search

cwjohan / markdown-to-html

Command-line utility to convert Github Flavored Markdown to HTML.
MIT License
236 stars 86 forks source link

Plantuml support / Gitlab Markdown #22

Open hcw70 opened 6 years ago

hcw70 commented 6 years ago

I am trying to convert several .md files which are written for gitlab markdown into a standalone html document for delivery.

These documents may contain plantuml tags to render UML charts ( see https://docs.gitlab.com/ee/administration/integration/plantuml.html ).

It would be great if markdown-to-html could add support for this so converting these files from the command line would be possible.

cwjohan commented 6 years ago

Sounds like a cool idea, but there may be a major roadblock -- it requires a PlantUML server. "Before you can enable PlantUML in GitLab; you need to set up your own PlantUML server that will generate the diagrams. Installing and configuring your own PlantUML server is easy in Debian/Ubuntu distributions using Tomcat."

On Wed, Sep 20, 2017 at 11:09 PM, Hauke Wintjen notifications@github.com wrote:

I am trying to convert several .md files which are written for gitlab markdown into a standalone html document for delivery.

These documents may contain plantuml tags to render UML charts ( see [ https://docs.gitlab.com/ee/administration/integration/ plantuml.html](Gitlab doc) ).

It would be great if markdown-to-html could add support for this so converting these files from the command line would be possible.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/cwjohan/markdown-to-html/issues/22, or mute the thread https://github.com/notifications/unsubscribe-auth/AH5q3Ah-1XlbPojCmBBuR7hsuUOWpmPvks5skf2VgaJpZM4Pe1xX .

hcw70 commented 6 years ago

Actually the gitlab approach is to use a plantuml server. But there are many ways to render plantuml, the most direct way is to call plantuml.jar from the command line. Btw, i found https://github.com/mikitex70/plantuml-markdown which is integrating it into http://pythonhosted.org/Markdown/ as a plugin. Maybe you can have a look there (and also i will look if it fits my needs).

cwjohan commented 6 years ago

If someone would rewrite plantuml.jar in NodeJS, it would make integration a lot easier. :-)

While I would love to see something like Plantuml become usable in markdown-to-html, I think it's too big a change for me to undertake in the near future. I'm quite busy with other things just now. However, I urge anyone who would like to make it happen to go ahead and do so, forking this project if that seems the best way to do it. Cheers.

On Fri, Sep 22, 2017 at 12:02 AM, Hauke Wintjen notifications@github.com wrote:

Actually the gitlab approach is to use a plantuml server. But there are many ways to render plantuml, the most direct way is to call plantuml.jar from the command line. Btw, i found https://github.com/mikitex70/ plantuml-markdown http://url which is integrating it into http://pythonhosted.org/Markdown/ http://url as a plugin. Maybe you can have a look there (and also i will look if it fits my needs).

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/cwjohan/markdown-to-html/issues/22#issuecomment-331367545, or mute the thread https://github.com/notifications/unsubscribe-auth/AH5q3DmYsv-i73ZGcsKWsyMG0Ndw4MXKks5sk1uCgaJpZM4Pe1xX .