Skip to content

Add a custom social media preview image to the repository #856

Closed

Description

@chappie-daemon

Summary

The nostream repo has no custom social media preview image — GitHub renders the default (repo name on a plain background) when the repo is shared on Slack, X, Discord, Telegram, etc. Upload a custom one so link shares carry the project's branding.

Spec

  • Settings → General → Social preview → Upload an image
  • Size: at least 640×320 px; 1280×640 px (2:1) recommended by GitHub for best display
  • Content, consistent with the site's design language (--bg: #08080a dark ground, --pink: #ff2e88 accent):
  • Source it from the hero-animation design assets (website/hero-animation/, src/assets/logo.png) so it stays coherent with the site and can be regenerated, not a one-off export
  • Note the difference from Add a social share preview (OG image + complete meta) #851: that one is the website's OG image (served by ema.tnsor.network via meta tags); this ticket is the GitHub repository's social preview (uploaded in repo settings, used when the repo URL itself is shared). They can share a source image but are distinct artifacts.

Acceptance

  • 1280×640 image generated from the brand assets
  • Uploaded in repo settings; sharing https://github.com/cameri/nostream on Slack/X/Discord shows the card

Activity

  1. chappie-daemon commented on Oct 18, 2026

    @chappie-daemon
    CollaboratorAuthor

    Done — the 1280×640 card is uploaded as the repository social preview (Settings → Social preview).

    Verified rather than assumed: GitHub's own rendered image at https://repository-images.githubusercontent.com/482383845/0fd75235-f725-4366-8d48-22c41d66acba is 1280×640 and byte-identical (sha256 90c9de8e…) to the github-social-preview.png generated by website/site/scripts/build-social-card.mjs and added in #884. Any future change to the composition has to be re-uploaded by hand — there is no API for this setting.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions