Menu
Sign up

A GitHub social preview image from your repo

Type a repository. We read its name, description, stars, forks and language from GitHub and put them on a 1280×640 card — the size GitHub asks for. Download it and upload it in the repository settings.

Accent colour
Theme

Public repositories only. Free: 5 images an hour from one address, with a small watermark.

Your 1280×640 preview appears here.

How it works

  1. We parse the owner and name and ask GitHub's public API for the repository — never another address.
  2. Name, owner, description, stars, forks and the main language go into the built-in GitHub repository template, with the owner's avatar.
  3. Chrome renders it at 1280×640 as a PNG.

How to set it on GitHub

  1. Open the repository on GitHub and go to Settings (you need admin access to the repository).
  2. In General, find Social preview and click Edit → Upload an image…
  3. Choose the PNG you downloaded here. GitHub asks for at least 640×320 px, recommends 1280×640, and takes PNG, JPG or GIF under 1 MB.
  4. Share the repository link: X, LinkedIn, Slack and Discord show the new card. Run it through the Open Graph checker to see it.

Keep it current from code

The github-repo template is one of 153 built-in templates in the Shareglint API. Render it in CI on every release with fresh numbers — 100 images a month free.

Start free — 100 images a month OG image generator

Questions

What is a GitHub social preview?

The image GitHub uses as the repository's og:image — the card people see when the repo link is shared on X, LinkedIn, Slack or Discord. Without one, GitHub generates a plain card.

What size is a GitHub social preview image?

GitHub recommends 1280×640 pixels and requires at least 640×320, as PNG, JPG or GIF under 1 MB. This tool renders exactly 1280×640.

Does it work for private repositories?

No. We only read what GitHub shows to anyone without signing in.

Will the star count update by itself?

No — an uploaded image is fixed. To keep numbers current, render the card from code: the github-repo template through the API, on a schedule or on each release.