Skip to content

docs: use theme-aware logo in README#89

Merged
jaewon42 merged 2 commits intomainfrom
docs/theme-aware-readme-logo
Apr 23, 2026
Merged

docs: use theme-aware logo in README#89
jaewon42 merged 2 commits intomainfrom
docs/theme-aware-readme-logo

Conversation

@jaewon42
Copy link
Copy Markdown
Contributor

Summary

  • Swap the static <img src=\"logo.png\"> in the README for a <picture> element with prefers-color-scheme sources, so GitHub renders the black wordmark in light theme and the white wordmark in dark theme.
  • Add the two SVG variants (logo-black.svg, logo-white.svg) at the repo root alongside the existing logo.png.

Why

On dark-mode GitHub, the current black logo fades into the background. <picture> lets us serve the right asset per theme without JS, and GitHub's Markdown sanitizer specifically allows <picture> + <source media=\"(prefers-color-scheme: ...)\"> for this purpose.

Changes

  • README.md: replace <img src=\"logo.png\" ...> with:
    <picture>
      <source media=\"(prefers-color-scheme: dark)\" srcset=\"logo-white.svg\">
      <source media=\"(prefers-color-scheme: light)\" srcset=\"logo-black.svg\">
      <img src=\"logo-black.svg\" alt=\"LandingAI\" width=\"420\" />
    </picture>
  • Add logo-black.svg (~20KB) and logo-white.svg (~20KB).
  • Kept the existing logo.png in place in case any external doc/link still points at it.

Test plan

  • View the README on GitHub in light theme — shows the black wordmark.
  • Toggle GitHub Settings → Appearance → Dark — shows the white wordmark.
  • Check rendering on PyPI / mirrors that don't honor prefers-color-scheme — falls back to the black SVG.

🤖 Generated with Claude Code

Swap the static logo.png for a <picture> element with color-scheme
sources so the README renders the black wordmark in light theme and
the white wordmark in dark theme on GitHub. SVG assets added at repo
root alongside the existing logo.png.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 23, 2026 18:45
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s README branding so the displayed logo adapts to GitHub light/dark themes by serving different SVG variants via a <picture> element.

Changes:

  • Replace the README’s static logo.png <img> with a theme-aware <picture> using prefers-color-scheme.
  • Add new root-level logo assets: logo-black.svg (light theme) and logo-white.svg (dark theme).

Reviewed changes

Copilot reviewed 1 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Swaps the logo markup to a <picture> element with light/dark srcset sources.
logo-black.svg Adds the black wordmark SVG used for light theme / fallback rendering.
logo-white.svg Adds the white wordmark SVG used for dark theme rendering.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jaewon42 jaewon42 merged commit 2f49d2a into main Apr 23, 2026
7 checks passed
@stainless-app stainless-app Bot mentioned this pull request Apr 23, 2026
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