Skip to content

readme: theme-aware logo for GitHub dark mode#194

Merged
andrewwormald merged 2 commits into
mainfrom
fix/readme-logo-dark-theme
Apr 30, 2026
Merged

readme: theme-aware logo for GitHub dark mode#194
andrewwormald merged 2 commits into
mainfrom
fix/readme-logo-dark-theme

Conversation

@andrewwormald
Copy link
Copy Markdown
Collaborator

@andrewwormald andrewwormald commented Apr 30, 2026

Summary

  • Wraps the README logo in a <picture> element using GitHub's prefers-color-scheme media query, so logo_dark.svg is shown in dark mode and logo.svg in light mode.
  • Adds logo/logo.svg and logo/logo_dark.svg to the repo.

Test plan

  • View the README on GitHub with light theme — should show dark-on-light logo
  • View the README on GitHub with dark theme — should show light-on-dark logo

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated project logo to automatically switch between light and dark variants based on system preferences, improving visual consistency across different display modes.

Wraps the logo in a <picture> element so GitHub renders logo_dark.svg
when the viewer has dark mode enabled, and logo.svg for light mode.
Also adds the SVG logo files (light and dark variants).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@andrewwormald andrewwormald enabled auto-merge (squash) April 30, 2026 09:46
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 30, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a3eebfcf-d766-497c-920e-7118070e8723

📥 Commits

Reviewing files that changed from the base of the PR and between 2156b95 and bc6494f.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README.md file has been updated to implement theme-aware logo rendering. The change replaces a single <img> element with a <picture> element containing a <source> tag that serves a dark-mode-specific logo (logo_dark.svg) when the user's system prefers dark colour schemes, whilst retaining logo.svg as the default fallback image.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A logo that shifts with the night,
From light to dark, what a sight!
With picture elements so fine,
Both themes shall beautifully align,
README's magic now shines bright! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-logo-dark-theme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@andrewwormald andrewwormald merged commit 8a09a96 into main Apr 30, 2026
5 of 6 checks passed
@andrewwormald andrewwormald deleted the fix/readme-logo-dark-theme branch April 30, 2026 09:47
@sonarqubecloud
Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants