search

mermaid-js / mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
https://mermaid.js.org
MIT License
72.15k stars 6.56k forks source link

README edit with ``Gantt diagrams`` in Github #1804

Closed Charmve closed 3 years ago

Charmve commented 3 years ago

Hi,

the Gantt diagrams code doesn't work in README.

Could you please tell us how to deal with it?

Thanks.

@Charmve

BastianZim commented 3 years ago

Hi @Charmve,

which part exactly doesn't work for you?

The following code, listed under examples, works for me:

gantt
section Section
Completed :done,    des1, 2014-01-06,2014-01-08
Active        :active,  des2, 2014-01-07, 3d
Parallel 1   :         des3, after des1, 1d
Parallel 2   :         des4, after des1, 1d
Parallel 3   :         des5, after des3, 1d
Parallel 4   :         des6, after des4, 1d

Output:

Live editor

Charmve commented 3 years ago

Hi @BastianZim,

thanks for your reply.

The example is just a picture, it doest work in the md editor at Github README.md

image

You can see it here.

BastianZim commented 3 years ago

Ahh I thought you meant the code itself, now it's clear.

Yes, GitHub does not support rendering of mermaid diagrams currently. That is unfortunately a limitation of GitHub and cannot be changed by mermaid.

Feel free to add your support to this feature request: https://github.community/t/feature-request-support-mermaid-markdown-graph-diagrams-in-md-files/1922

A workaround used by most is to render the diagram manually in the mermaid-live-editor and then import it into GitHub or write a GitHub action using the mermaid-cli.

Charmve commented 3 years ago

Good luck!

Looking forward to realize this great tool !

Thanks a lot. 👊