Codimd: support PlantUML

[applideveloper]

I want to support PlantUML for Hackmd
http://dev.classmethod.jp/devenv/atom-plantuml-sequence/
http://plantuml.com/sequence-diagram

[jackycute]

Hi @applideveloper
Thanks for suggestion, PlantUML looks fantastic!

However, it requires Java which not able execute in the browser.
So this will increase back-end server dependency.
But seems like it also integrate Graphviz, so it might able to replace our dependency to viz.js.
And I found this package which might be really useful: https://github.com/markushedvall/node-plantuml

[applideveloper]

Thank you for @jackycute !
Are you planning to include node-plantuml in hackmd?

[jackycute]

I'm not really sure about that, maybe not for recent.
Because this will definitely let the server installation even harder (not compatible to some platforms).
And also make the server heavier, we'll have to put this in optional dependency.
Let's see how many people need this.

[ccoenen]

+1 for optional

in the long run, it would be nice to have all the renderers (including existing mermaid and so on) in something like hackmd plugins.

[joneepenk]

+1

[metal3d]

+1 also - a real need

[svast]

+1 also, would be a great addon

[MartB]

+1

[rubyshen]

+1

[ccoenen]

I think that's a clear vote.

[SISheogorath]

For those who want to implement it:

https://www.npmjs.com/package/markdown-it-plantuml

Time to get some pull request ;)

[Yukaii]

Shipped in 1.4.0

[pihentagy]

Shipped in 1.4.0

What is the correct syntax to use? Cannot find in the docs.

[jackycute]

Shipped in 1.4.0

What is the correct syntax to use? Cannot find in the docs.

Hi @pihentagy, it was shipped in #1096
Please write with:

(plantuml code)

[pihentagy]

Shipped in 1.4.0

What is the correct syntax to use? Cannot find in the docs.

Hi @pihentagy, it was shipped in #1096
Please write with:

(plantuml code)

Just installed codimd from docker, and seems to not work in that form.
The list of supported languages does not contain plantuml, and all I see is the plantuml code. Btw should I include @startuml / @enduml? What will happen if my plantuml code is buggy?

[jackycute]

Shipped in 1.4.0

What is the correct syntax to use? Cannot find in the docs.

Hi @pihentagy, it was shipped in #1096
Please write with:

(plantuml code)

Just installed codimd from docker, and seems to not work in that form.
The list of supported languages does not contain plantuml, and all I see is the plantuml code. Btw should I include @startuml / @enduml? What will happen if my plantuml code is buggy?

Could you make sure you're using image nabo.codimd.dev/hackmdio/hackmd:1.4.1?
If your editor supports plantuml, it will show up autocomplete like this:

You can try here:
https://codimd-app.herokuapp.com/Ak2Y2aAmSQOfAppLAFDOiw

[pihentagy]

Shipped in 1.4.0

What is the correct syntax to use? Cannot find in the docs.

Hi @pihentagy, it was shipped in #1096
Please write with:

(plantuml code)

Just installed codimd from docker, and seems to not work in that form.
The list of supported languages does not contain plantuml, and all I see is the plantuml code. Btw should I include @startuml / @enduml? What will happen if my plantuml code is buggy?

Could you make sure you're using image nabo.codimd.dev/hackmdio/hackmd:1.4.1?
If your editor supports plantuml, it will show up autocomplete like this:

You can try here:
https://codimd-app.herokuapp.com/Ak2Y2aAmSQOfAppLAFDOiw

Thanks. I installed the server from here: https://github.com/codimd/server/blob/master/docs/setup/docker.md and using 1.5.1:

Status: Downloaded newer image for postgres:9.6-alpine
Pulling app (quay.io/codimd/server:1.5.0)...
1.5.0: Pulling from codimd/server
146bd6a88618: Pull complete

[jackycute]

Shipped in 1.4.0

What is the correct syntax to use? Cannot find in the docs.

Hi @pihentagy, it was shipped in #1096
Please write with:

(plantuml code)

Just installed codimd from docker, and seems to not work in that form.
The list of supported languages does not contain plantuml, and all I see is the plantuml code. Btw should I include @startuml / @enduml? What will happen if my plantuml code is buggy?

Could you make sure you're using image nabo.codimd.dev/hackmdio/hackmd:1.4.1?
If your editor supports plantuml, it will show up autocomplete like this:

You can try here:
codimd-app.herokuapp.com/Ak2Y2aAmSQOfAppLAFDOiw

Thanks. I installed the server from here: codimd/server:docs/setup/docker.md@master and using 1.5.1:

Status: Downloaded newer image for postgres:9.6-alpine
Pulling app (quay.io/codimd/server:1.5.0)...
1.5.0: Pulling from codimd/server
146bd6a88618: Pull complete

Hi @pihentagy, it's a different image and we don't maintain that version.
Please use nabo.codimd.dev/hackmdio/hackmd:1.4.1 instead, so you can use vega-lite and plantuml.

[pihentagy]

Hi @pihentagy, it's a different image and we don't maintain that version.
Please use nabo.codimd.dev/hackmdio/hackmd:1.4.1 instead, so you can use vega-lite and plantuml.

Oh, just noticed there are two repositories, and installed the one from a doc in https://github.com/codimd/server. This repo is however https://github.com/hackmdio/codimd. Both repositories seems to be active. What is the relation between them? :confused:

[jackycute]

Hi @pihentagy, it's a different image and we don't maintain that version.
Please use nabo.codimd.dev/hackmdio/hackmd:1.4.1 instead, so you can use vega-lite and plantuml.

Oh, just noticed there are two repositories, and installed the one from a doc in codimd/server. This repo is however hackmdio/codimd. Both repositories seems to be active. What is the relation between them? 😕

Please follow our documentation to deploy with docker: https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment

That is a hard fork of this repo.

[pihentagy]

Thanks for the info. However: in the docs there are hardcoded version numbers (like nabo.codimd.dev/hackmdio/hackmd:1.4.1), which make upgrade more "manual" I guess.

[jackycute]

Thanks for the info. However: in the docs there are hardcoded version numbers (like nabo.codimd.dev/hackmdio/hackmd:1.4.1), which make upgrade more "manual" I guess.

We recommend specify the version you like to pull, since we might release some rc version in the future and also avoid unintended breaking changes (read upgrade guide first is better).

[pihentagy]

Fair enough. Then how one knows when and how to upgrade?

On Wed, Jan 15, 2020 at 10:49 AM Max Wu [e-mail] wrote:

Thanks for the info. However: in the docs there are hardcoded version
numbers (like nabo.codimd.dev/hackmdio/hackmd:1.4.1), which make
upgrade more "manual" I guess.

We recommend you specify the version you like to pull, since we might
release some rc version in the future and also avoid unintended breaking
changes.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/hackmdio/codimd/issues/362?email_source=notifications&email_token=AAAHJXFO7F72HHCUFOVEAETQ53LYZA5CNFSM4DAQB6XKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEI7WPVA#issuecomment-574580692,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAAHJXHUTWGDSGGMBHNSWILQ53LYZANCNFSM4DAQB6XA
.

[jackycute]

Fair enough. Then how one knows when and how to upgrade?

You can watch this repo for any further release!