Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mermaid markdown rendering does not work in the Github Wiki #15727

Open
1 task done
Neudrino opened this issue Feb 22, 2022 · 9 comments
Open
1 task done

Mermaid markdown rendering does not work in the Github Wiki #15727

Neudrino opened this issue Feb 22, 2022 · 9 comments
Labels
content good first issue help wanted
Projects
Docs open source board

Comments

@Neudrino
Copy link

@Neudrino Neudrino commented Feb 22, 2022

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;
@Neudrino Neudrino added the content label Feb 22, 2022
@github-actions github-actions bot added the triage label Feb 22, 2022
@github-actions github-actions bot added this to Triage in Docs open source board Feb 22, 2022
@ramyaparimi ramyaparimi added waiting for review and removed triage labels Feb 22, 2022
@ramyaparimi
Copy link
Collaborator

@ramyaparimi ramyaparimi commented Feb 22, 2022

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

@skedwards88
Copy link
Contributor

@skedwards88 skedwards88 commented Feb 24, 2022 •
edited

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
Copy link

@mikewink mikewink commented Mar 28, 2022

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
Copy link
Author

@Neudrino Neudrino commented Apr 5, 2022

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.

@ramyaparimi ramyaparimi added help wanted good first issue and removed waiting for review labels Apr 5, 2022
@ramyaparimi ramyaparimi moved this from Triage to Help wanted in Docs open source board Apr 5, 2022
@mikewink
Copy link

@mikewink mikewink commented Apr 6, 2022

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

This comment was marked as spam.

Sign in to view
@Neudrino
Copy link
Author

@Neudrino Neudrino commented Apr 7, 2022

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
Copy link

@zykadelic zykadelic commented Apr 11, 2022

@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
Copy link

@mcpierce mcpierce commented Apr 11, 2022

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:
Screen Shot 2022-04-11 at 9 55 09 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content good first issue help wanted
Projects
Docs open source board
Help wanted
Milestone
No milestone
Development

No branches or pull requests
7 participants
@mcpierce @zykadelic @Neudrino @skedwards88 @ramyaparimi @mikewink @Yoyoqw