Skip to content

Add rendering of Mermaid diagrams #533

Closed

Description

@piranna

Mermaid allow the rendering of diagrams from markdown-like text snippets. Code-highlighting could be reused to render them when setting mermaid as the languaje. This is related to #334

Activity

  1. gjtorikian commented on Aug 7, 2015

    @gjtorikian
    Contributor

    I wonder if this is something @github/render would be interested in picking up? The project does look interesting.

    @piranna Can you give us a sense of how this is currently used across GitHub? Is there an extension for the file format, for example?

  2. piranna commented on Aug 7, 2015

    @piranna
    Author

    @piranna Can you give us a sense of how this is currently used across GitHub? Is there an extension for the file format, for example?

    I've not seen anybody using it on GitHub, maybe because it's not an available functionality, nor know of any browser extensión.

    On the other hand, I've seen a webservice that generate PNG images from Mermaid snippets that can be inserted on Markdown files (sorry, I can't find the link now) and a quick search has shown me other use cases, like a plugin for gitbook, a plugin for LightTable and a plugin for Jekyll (maybe you would be more interested in that last one).

  3. alanjames1987 commented on Sep 6, 2016

    @alanjames1987

    +1

  4. trusch commented on Feb 26, 2017

    @trusch

    +1

  5. kivikakk commented on Mar 23, 2017

    @kivikakk
    Contributor

    This isn't quite a markup-related issue so I'm closing the issue, but we're definitely still thinking about things like this. If you have other feature requests, please reach out to the support team.

  6. wmertens commented on Aug 11, 2017

    @wmertens

    Note, in v1.15 of VSCode they enabled extensions for the markdown previewer, and there is https://github.com/mjbvz/vscode-markdown-mermaid which renders the images inline.

  7. wmertens commented on Dec 1, 2017

    @wmertens

    @kivikakk So the request here was to add support for Mermaid, which would be two-fold:

    • Support rendering .mermaid files
    • Support rendering ```mermaid code blocks as Mermaid. I am not sure if this is possible? Are code blocks always passed to linguist?

    It seems to me that this is indeed related to markup?

  8. kivikakk commented on Dec 4, 2017

    @kivikakk
    Contributor

    It seems to me that this is indeed related to markup?

    This repo is for things relating specifically to the github-markup gem; if an issue cannot be resolved by some change to code in this repo, then it doesn't belong here (and instead belongs with the support team). I hope that helps clarify!

  9. themightychris commented on Jan 5, 2018

    @themightychris

    Did an issue over get created in the appropriate place for this? It would be an amazing addition to github

  10. wmertens commented on Jan 5, 2018

    @wmertens

    @themightychris I think the appropriate repo is https://github.com/gjtorikian/commonmarker, not sure, no issue created yet.

  11. kivikakk commented on Jan 5, 2018

    @kivikakk
    Contributor

    The correct destination is the support team! They handle feature requests for github.com.

  12. marcussacana commented on Feb 17, 2018

    @marcussacana

    any news?

  13. 9 remaining items

  14. trusch commented on Jan 4, 2019

    @trusch
  15. cristianvasquez commented on Jan 18, 2019

    @cristianvasquez

    +1

  16. dderiso commented on Jan 18, 2019

    @dderiso

    @localredhead That's certainly close. All one needs to do is integrate an SVG to PNG converter that can produce a url with the png encoded in base64. This seems relevant.

  17. tom-sherman commented on Jan 25, 2019

    @tom-sherman

    Would love for this to be revisited, especially since GitLab directly supports mermaid in markdown.

  18. rkclark commented on Jan 30, 2019

    @rkclark

    +1

  19. shashank-sharma commented on Feb 2, 2019

    @shashank-sharma

    This feature can greatly increase the quality of documentation we have in GitHub ... Waiting!

  20. matthew-cochran commented on Feb 7, 2019

    @matthew-cochran

    +1

  21. John-Youngblood commented on Feb 11, 2019

    @John-Youngblood

    +1

  22. rferro commented on Feb 14, 2019

    @rferro

    +1

  23. dderiso commented on Feb 14, 2019

    @dderiso

    @kivikakk Can you please re-open this? It seems to be a markup related question.

  24. kivikakk commented on Feb 15, 2019

    @kivikakk
    Contributor

    The correct destination is the support team! They handle feature requests for github.com.

    This is still the case! github-markup does not handle rendering; it only chooses a markup library for use. If you want support for Mermaid diagrams, the correct destination is the support team. Thanks.

  25. Yamilquery commented on Apr 2, 2019

    @Yamilquery

    That's it! I already contact them to ask for this awesome feature. We hope to have support with a mermaid in GitHub. In our case is a waste of time to have to transform all our mermaid diagrams to png images and upload. It's very complicated for us.

  26. DrCapa commented on Apr 7, 2019

    @DrCapa

    +1

  27. kivikakk commented on Apr 7, 2019

    @kivikakk
    Contributor

    Thanks for submitting this correctly! I'll lock this thread now as +1s will only get seen by me, the markup gem maintainer, and not by the people who are responsible for feature requests. :)

  28. locked as resolved and limited conversation to collaborators on Apr 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions