search

NuGet / NuGetGallery

NuGet Gallery is a package repository that powers https://www.nuget.org. Use this repo for reporting NuGet.org issues.
https://www.nuget.org/
Apache License 2.0
1.52k stars 644 forks source link

[README] Support Mermaid diagrams #8942

Open loic-sharma opened 2 years ago

loic-sharma commented 2 years ago

Related Problem

GitHub has Mermaid diagrams on their roadmap: https://github.com/github/roadmap/issues/372

A README containing this:

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


Renders as:

![](https://user-images.githubusercontent.com/1767415/147986289-f8283c0b-aa5e-4381-bd69-876edeef12d9.png)

### The Elevator Pitch

NuGet should support this too!

### Additional Context and Details

Part of the README effort: https://github.com/NuGet/NuGetGallery/issues/8837

/cc @clairernovotny
devlead commented 1 month ago

Now Mermaid diagrams aren't just on the GitHub roadmap but shipped little over two years ago (February 14, 2022), so more and more READMEs utilize Mermaid, so it would be a great improvement if the NuGet .org gallery supported it too.