-
Notifications
You must be signed in to change notification settings - Fork 644
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
Package readme display creates a <br> for every markdown newline, against markdown specification #8642
Comments
@kzu , thanks for reporting! We will take a look in July. If you are interested in sending a PR we will gladly work with you on merging and shipping this change. |
Sure thing! Which repo has the code for the gallery? |
@kzu, here is repo: https://github.com/NuGet/NuGetGallery |
Another similar report, simply based on newline behavior in text. From our assessment, this seems to be the same root cause as #8647. |
Yes, indeed this is just a case of creating a
See https://www.nuget.org/packages/dotnet-gcm/ for another example. |
@lyndaidaii This still seems to happen (again) when uploading a package to nuget.org. Could you please check that again? |
This issue should be reopened as Nuget creates new lines against the Markdown spec. |
See the readme-provided badges on this package: https://www.nuget.org/packages/Devlooped.TableStorage/2.0.1.
The source readme is https://github.com/devlooped/TableStorage/blob/v2.0.1/readme.md.
Notice how github.com does not add newlines even if the badges are defined in the readme source in separate lines (but without an empty line break between them), and instead just considers the line break as a single whitespace instead:
snip of source readme:
I'd expect the nuget.org render to follow more closely with github.com in this particular case, since it's not uncommon for projects to provide several such badges and forcing to put them all without line breaks (as I had to do for this package) hinders source readability and maintainability. I think it's also the more common markdown behavior for single line breaks.
The text was updated successfully, but these errors were encountered: