docs(readme): use absolute URLs for logo images#20
Closed
nh13 wants to merge 1 commit into
Closed
Conversation
Use https://raw.githubusercontent.com/<org>/<repo>/main/... for logo references so they render on crates.io. Relative paths render correctly on GitHub but are dropped by the crates.io README sanitizer, leaving a broken image at the top of every crate page.
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.
Why
crates.io strips relative image paths from rendered READMEs, so the logo at the top of this crate's page on crates.io is broken. Switching to absolute
raw.githubusercontent.comURLs renders correctly on both GitHub and crates.io.What changed
srcset/srcpaths with absolute raw URLs pinned tomain.<picture>dark/light switching; crates.io ignores<source>and falls back to the<img>(light variant), which is the same behavior as before, just no longer broken.Note
The crate page itself only updates on the next published version — this PR prevents future releases from being broken, but doesn't refresh the existing crate page.
Stacked on top of #19 (clippy fixes for rust-1.95). When #19 merges, this PR will auto-retarget to
mainand the diff will be the README change only.