NuGetGallery icon indicating copy to clipboard operation
NuGetGallery copied to clipboard

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

Open baronfel opened this issue 4 years ago • 2 comments

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

  • NPM - no support for release notes/changelog, just a static list of versions
  • Crates.io - no support for release notes/changelog, provides a list of versions with release metadata and clickable links
  • Maven Central - no support for release notes/changelog, a list of versions is provided to swap views of metadata
  • VSCode Marketplace - supports markdown changelogs
  • VS Marketplace - no support for release notes/changelog that I can see

baronfel avatar Nov 22 '21 14:11 baronfel

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

gregsdennis avatar Dec 26 '22 17:12 gregsdennis

Would love to see span tag support. I use them as markers for dynamic updates of content in my build process and they look terrible in NuGet readme view: https://www.nuget.org/packages/Finbuckle.MultiTenant#readme-body-tab

AndrewTriesToCode avatar Nov 14 '24 17:11 AndrewTriesToCode