Repository navigation
docs: a light How it works preview, and a logo that follows the theme again - #26
Merged
Merged
Conversation
… again The README shows the How it works preview in the reader's theme, a light GIF beside the dark one, both with one palette per frame so the soft background no longer bands. Wrapping a picture in a link made GitHub move its image out, so the logo stopped following the theme after the last README change; both pictures are bare again, and check_site.py fails if one sits inside a link.
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
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.
What changes
assets/how-it-works.gifis now the light version andassets/how-it-works_dark.gifthe dark one, following the repository'sname/name_darkconvention (asrecore_logoand the benchmark figure do). Both were captured from the page at the same size, and each frame now has its own 256-colour palette, so the soft halo behind the drawings no longer shows bands (336 KB and 304 KB).<picture>in a link to the website. GitHub's renderer then moves the<img>out of the<picture>, so the logo stayed light in dark mode and clicking it opened the SVG file. Both pictures are bare again; the website button under the logo and the caption under the preview still take readers to the site.Checks
tools/check_site.pynow fails if a<picture>sits inside a link in the README. It was broken on purpose (the logo wrapped in a link again) and caught it.I checked the result with GitHub's own markdown API: both pictures come out as
themed-picturewith their image inside, and the light theme picksrecore_logo.svgandhow-it-works.gifwhile the dark theme picks the_darkfiles. Locally fmt, clippy, the tests, the build,check_site.py --run-tutorialand the auto-merge gate check all pass.