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.54k stars 642 forks source link

[Feature]: Render Release Notes as Markdown in the same way as READMEs are #8889

Open baronfel opened 2 years ago

baronfel commented 2 years ago

Related Problem

As a package user, I enjoy the new README markdown support in NuGet.org, but when I go to packages I already use to see what's changed between releases, the Release Notes for that package show unformatted markdown, which is difficult to read compared to the rendered form.

The Elevator Pitch

The new Release Notes and README support on the NuGet website is great! READMEs in particular are a great experience for people using the gallery for package discovery. The Release Notes tab looks a little drab by comparison, unfortunately. It would be great if the Release Notes tab could render Markdown in the same way as READMEs in order to present a unified experience to a viewer. Many packages use markdown for links, bulleted lists, and sometimes even embedded images to demonstrate changes, and unifying that would be a marked (heh) improvement in my view.

Additional Context and Details

gregsdennis commented 1 year ago

Yes, this. Absolutely this. I'm amazed release notes as markdown weren't done to begin with given readme already supports it.