fix: replace HTML with standard markdown in README for nuget.org rendering#10
Merged
Conversation
…ering NuGet's markdown renderer does not support HTML tags like <p> and <img>. Replace with standard markdown syntax and use absolute GitHub URLs for images so they render correctly on both GitHub and nuget.org.
The full-size logo (1254x1254) renders too large in both GitHub and nuget.org since standard markdown has no width attribute. Use a dedicated 180px version (logo-sm.png) for the README while keeping the original for the NuGet package icon.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
NuGet's markdown renderer does not support HTML tags. The
<p align="center">and<img>tags at the top of the README were rendering as raw text on nuget.org package pages.Additionally, the relative image path
assets/logo.pngcannot be resolved by nuget.org.Fix
<p>/<img>HTML with standard markdown image syntax<a><img>to markdown[![]()]()syntaxResult
Both GitHub and nuget.org will render the logo and CI badge correctly.