Mermaid markdown rendering does not work in the Github Wiki

[Neudrino]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams

What part(s) of the article would you like to see updated?

The usual Github text input boxes hold a reference to the basic writing and formatting syntax. Next to this item you can find the section Working with advanced formatting. Within this section a documentation of writing Mermaid diagrams can be found.

However writing those diagrams in Github wiki, does not get rendered. See this example.

Imho, the documentation should clearly state, where this feature is available and where not.
(Why this is the case would be nice to know, but is not essential.)

Additional information

It seems as that it depends, where the syntax is used. Eg. in this fields it is rendered correctly.

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Loading

[ramyaparimi]

@Neudrino
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[skedwards88]

Thanks for opening this issue! You are correct that Mermaid syntax does not currently work for wikis. You or anyone else is welcome to open a PR to document this. (Note: This functionality may be added in the near future.)

[mikewink]

It would be awesome to have Mermaid support in wikis. I wanted to use them to document an ERD for a new project I'm working on.

[Neudrino]

Today, we're excited to add native support for Mermaid wherever Markdown is supported [...].

This was stated in github/roadmap#372 and the issue was closed 2022-02-14.

As far as I can see, mermaid is supported in the Wiki now. If some commenter can confirm and react with a 👍 , I would be inclined to close this issue resolved without further action.

[mikewink]

As far as I can see, mermaid is supported in the Wiki now. If some commenter can confirm and react with a 👍 , I would be inclined to close this issue resolved without further action.

I used the example from github/roadmap#372 in a new wiki page in my latest created repository and it still does not work for me. It's working fine in issues.

And based on the comment of @skedwards88 it's still a thing.

Thanks for opening this issue! You are correct that Mermaid syntax does not currently work for wikis. You or anyone else is welcome to open a PR to document this. (Note: This functionality may be added in the near future.)

So please, do not close this.

[Yoyoqw]

👍

…

On Wed, Apr 6, 2022, 4:38 PM Mike Wink ***@***.***> wrote: As far as I can see, mermaid is supported in the Wiki now. If some commenter can confirm and react with a 👍 , I would be inclined to close this issue resolved without further action. I used the example from github/roadmap#372 <github/roadmap#372> in a new wiki page in my latest created repository and it still does not work for me. It's working fine in issues. And based on the comment of @skedwards88 <https://github.com/skedwards88> it's still a thing. Thanks for opening this issue! You are correct that Mermaid syntax does not currently work for wikis. You or anyone else is welcome to open a PR to document this. (Note: This functionality may be added in the near future.) So please, do not close this. — Reply to this email directly, view it on GitHub <#15727 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AW6PW4V3QUKWE5ZQDHHLYH3VDX76DANCNFSM5PBRZXRA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[Neudrino]

So please, do not close this.

Ok, we can keep it open for now.

However, interesting, that it is only working for some people. Not sure why this would happen, but maybe gradual roll-out across the Github infrastructure world-wide? Or maybe it is rolled out to organisations first?

Anyways, you may find an usage example in our wiki and the code I used is (without the # which I inserted to have it not rendered here):

#```mermaid
#graph LR;
#    A-->B;
#    A-->C;
#    B-->D;
#    C-->D;
#```

[zykadelic]

@Neudrino are you saying it's rendering on that wiki page for you? Because it's not for me :( In the network tab I can clearly see how mermaid is being loaded on this page, but not on that wiki page. Instead I just see a regular code block.