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;

[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.

[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.

[mcpierce]

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.

Please don't close this. This feature is not working on all wiki pages. My project uses Mermaid for some diagrams in preparation for it being enabled, and they still do not render correctly. See below for this page:

[kylebebak]

Just so there's no confusion -- rendering mermaid is definitely not supported in Wiki pages.

It's not being gradually rolled out across GitHub infra as @Neudrino suggested. It's not supported anywhere, as @skedwards88 already confirmed above in this thread.

With that out of the way... I'd love support for mermaid in Wiki pages. There are diagrams and documentation that don't belong in a repo, which is why Wiki pages exist. Getting code into repos isn't trivial. For example, at many companies, CI checks have to run and pass for anything to get merged into main.

Support for mermaid would make Wiki pages a lot more powerful.

---

You or anyone else is welcome to open a PR to document this.

@skedwards88 What did you mean by this? Against which repo should someone open a PR? What should be in that PR that's not already documented in this issue?

[rick-palmsens]

Yup, not working on the wiki:

[sundlemonflux]

Just commenting for bump-up. We wanted to use diagrams for (wiki) documentation, and got excited about reading Mermaid support in Github, only to found it doesn't work for wiki 😢

Would be nice to get official word if this is intentional or a bug, and if the support is planned or not.

[Archie-Elvie]

Just commenting for bump-up. We wanted to use diagrams for (wiki) documentation, and got excited about reading Mermaid support in Github, only to found it doesn't work for wiki 😢

Would be nice to get official word if this is intentional or a bug, and if the support is planned or not.

This thread has a reply from GithHub. They are aware and were planning on rolling out in March or April.

[Candas1]

I am also looking forward using Mermaid Diagrans in the wiki.
But as a workaround, you can still copy the image in the mermaid live editor and embed it in your wiki:

Clicking on the diagram takes you back to the editor, and you still have access to the markdown code.
When the issue is finally fixed, you could copy the markdown code directly in the wiki.

[ramyaparimi]

Thank you everyone for the above conversation and discussions. You can send your feedback is to https://support.github.com/contact/feedback 💛

[jonasbn]

Hi @ramyaparimi

I am not sure I understand, do you want us to direct our requests for feature support for Mermaid in the GitHub wiki to the feedback mechanism.

I will happily do so, but I just want to be clear.

[ramyaparimi]

@jonasbn Thanks so much for clarifying. I spoke with the team and sending this feedback to the support team would be way to request for this feature.

Thanks so much for contribution to the GitHub docs 💖 .

[CRamsan]

This issue was closed but the feature is still not available, Can we please reopen it for tracking purposes?

[djfurman]

If this issue is not the correct place to keep the feature request open for the wiki support, can anyone direct to where we can make it a request?

[zykadelic]

https://github.com/orgs/github-community/discussions/11612 has the latest updates on wiki support

[vanjac]

Above link is broken, here's the discussion page: https://github.com/orgs/community/discussions/11612

[rushtonmd]

In case anyone is following this thread - Wikis now support Mermaid diagrams - see the changelog for more info.