Put the demo image on one line so GitHub renders it - #43
Merged
Conversation
GitHub's markdown renderer left a blank gap where the GIF should be. The tag was valid HTML but had its attributes split across lines inside a <p>, which the renderer does not reliably parse in a markdown document. The file and URL were fine: raw.githubusercontent serves 863K of image/gif at 1500x500.
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.
The README showed a blank gap where the demo GIF should be.
The tag was valid HTML, but its attributes were split across lines inside a
<p>, which GitHub's markdown renderer does not reliably parse. Single-lining it fixes the render.The file itself was never the problem:
raw.githubusercontent.com/.../docs/demo.gifreturns 200 with 863K ofimage/gifat 1500x500.Also tightens the alt text to describe what the GIF shows.
twine checkstill passes.