GitHub Social Preview Generator: Create and Add the Right Repository Image

A GitHub social preview generator creates the image GitHub displays when someone shares your repository link. You do not need a special GitHub app: prepare a PNG, JPG, or GIF, then upload it from the repository’s Settings → Social preview area. GitHub’s current recommendations are a minimum of 640 × 320 pixels, with 1280 × 640 pixels producing the best display, and a file size below 1 MB.

What a GitHub social preview generator actually does

GitHub calls this image the repository’s social media preview or Social preview. It is the visual card associated with a repository URL when that URL is shared. A generator is simply the design step: you create a wide image containing your project name, a short description, branding, or a useful visual, then upload the finished file to GitHub.

#	Preview	Product	Price
1		125 avgrafx 3x2 Rectangle Custom Personalized Stickers Labels: Vinyl Waterproof, Dishwasher Safe...	$37.99	Buy on Amazon

GitHub accepts these formats and limits:

These are GitHub’s current documentation recommendations, not a guarantee that every social network will crop or display the image identically. Keep important text and logos away from the edges so modest cropping does not remove them.

How to design the image

Start with a 2:1 canvas

Create a 1280 × 640 pixel document when practical. The 2:1 ratio gives you room for a project title, a concise value statement, and one visual element without forcing tiny text. If your editor uses a different document size, preserve the same ratio and export below 1 MB.

#1 Best Overall

125 avgrafx 3x2 Rectangle Custom Personalized Stickers Labels: Vinyl Waterproof, Dishwasher Safe Made in USA - Logo, Text, Image for Car Sticker Printer, Small Business Packaging Supplies

• Create eye-catching designs with these 3x2 Rectangle custom personalized stickers labels vinyl waterproof dishwasher perfect for custom stickers and labels to promote a small business or restaurant.
• Made from easy to install gloss bubble free vinyl no unsightly bubbles on your labels again. Easy peel and stick great for small business packaging. Make your own logo stickers for branding.
• We use a premium white vinyl that is UV resistant, waterproof and tearproof and will last for many years outdoors and indefinitely indoors. Will stick to most surfaces. Get your custom label stickers today for business, announcements, wedding and birthday.
• Uniquely identify business items by adding personalized logos, text or images on the logo stickers and custom decal. Stickers are on 9x11 sheet for easy peel and stick or as a option individually cut
• All avgrafx custom stickers are produced in our commercial print shop in Southern Ca. with Premium American made Vinyl. Using latest technology large format cutters and printers with the most up to date technology. Made and Shipped in the USA. No import fees for US Buyers.

$37.99

Buy on Amazon

Use a clear information hierarchy

• Primary line: the repository or product name.
• Secondary line: what the project does, in a few words.
• Supporting element: a logo, illustration, code motif, or restrained pattern that reinforces the subject.

Test the file at a small preview size. If the title cannot be read when the image is reduced, remove decorative detail before reducing the type.

Choose transparency deliberately

GitHub supports transparent PNG files, but the artwork can look different over light, dark, or colored backgrounds and on platforms that handle transparency differently. Check the image against several background colors. If you do not know where the link will be shared, use a solid background; that is GitHub’s safer recommendation.

Export and check the file

• Export as PNG, JPG, or GIF.
• Confirm the dimensions are at least 640 × 320 pixels; 1280 × 640 is the practical target.
• Check that the file is smaller than 1 MB, not exactly 1 MB.
• Open the exported file outside your editor to catch missing fonts, transparency surprises, or an accidental low-resolution export.

Upload a social preview to a GitHub repository

1. Open the repository’s main page on GitHub.
2. Choose Settings below the repository name. If the tab is hidden, open the repository tab dropdown and select Settings.
3. Find the Social preview section.
4. Choose Edit, then Upload an image, and select your PNG, JPG, or GIF.
5. Wait for the preview to appear, then save or leave the settings page according to the controls shown by GitHub.

To replace an image, upload the replacement in the same section. To clear it, choose Remove image. GitHub’s labels and the exact location may move as its interface changes, but the repository Settings and Social preview concepts remain the relevant path.

Public and private repository rules

You can upload a preview to a public repository. GitHub also permits uploading one to a private repository when an image was previously uploaded there. The preview can be shared from a public repository only. If a private repository link is sent to someone without access, the repository’s visibility and permissions still control what that person can see; the image is not a way to make private source code public.

Make a repository preview that survives sharing

Keep the message short

Use one recognizable project name and one useful promise. A social card is not a README: avoid paragraphs, configuration instructions, or a long list of technologies. Put the detail in the repository description and README instead.

Protect the safe area

Leave comfortable margins around text and logos. Different destinations can resize or crop link previews, and GitHub’s documentation does not promise identical rendering on each platform. A centered title with generous padding is more robust than edge-to-edge lettering.

Use contrast instead of effects

Strong contrast, a simple background, and a single focal point remain readable when the card is shown as a small thumbnail. If you use a transparent PNG, inspect it on both light and dark backgrounds before uploading.

Keep versions organized

Save the source design separately from the exported upload. Name exports with the repository and dimensions, such as project-social-1280×640.png. When the project identity changes, you can replace the image without rebuilding the design from scratch.

Common problems and fixes

The Social preview section is missing

Confirm that you are on the repository’s main page and that you have permission to change repository settings. If the Settings tab is collapsed, use the tab dropdown. Organization policies or insufficient privileges can also prevent access; ask a repository administrator rather than trying to edit the README as a substitute.

GitHub rejects the upload

Check the three documented constraints first: the file must be PNG, JPG, or GIF; it must be under 1 MB; and it should meet the recommended dimensions. Re-exporting a large PNG as an optimized JPG can reduce size, but inspect the result for compression artifacts. Do not simply rename another format’s extension.

The image looks wrong on a dark background

This commonly occurs with transparent PNG artwork or low-contrast text. Preview the file on light and dark backgrounds, then add a solid background or adjust the foreground colors. GitHub explicitly cautions that transparency varies by background and platform.

The old image still appears after replacement

First verify that the replacement is visible in the repository’s Social preview section. A third-party platform may have retained an earlier link-preview copy; GitHub’s documentation does not specify cache-refresh timing for every network. Check the repository itself before diagnosing a sharing platform.

The card is blurry or text is clipped

Use the 1280 × 640 target rather than enlarging a smaller file, and keep the important content inside the margins. Export once at the intended dimensions instead of repeatedly scaling a compressed image.

Or skip the browser setup

If you want a current repository page as the starting artwork, ScreenshotNeo can return a website screenshot through one request. It is a capture service, not a replacement for designing typography, so crop or add your own branding afterward and export the final file within GitHub’s 1 MB limit. Full-page capture, viewport and device controls, custom CSS, hidden selectors, dark mode, retina scale, and image resizing are available when you need to shape the captured page.

The simplest request is:

curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://github.com/OWNER/REPOSITORY -o shot.webp

ScreenshotNeo’s API returns WebP by default in this example. Convert or request an output suitable for your editor before uploading to GitHub. See the ScreenshotNeo documentation for parameters and output options.

Python

import requests

r = requests.get(
    "https://api.screenshotneo.com/v1/shot",
    params={"access_key": "YOUR_API_KEY", "url": "https://github.com/OWNER/REPOSITORY"},
    timeout=90,
)
r.raise_for_status()
open("shot.webp", "wb").write(r.content)

Node.js

const q = new URLSearchParams({
  access_key: 'YOUR_API_KEY',
  url: 'https://github.com/OWNER/REPOSITORY'
});
const res = await fetch(`https://api.screenshotneo.com/v1/shot?${q}`);
if (!res.ok) throw new Error(`Screenshot failed: ${res.status}`);
const fs = await import('node:fs/promises');
await fs.writeFile('shot.webp', Buffer.from(await res.arrayBuffer()));

For a social-preview workflow, ScreenshotNeo’s useful distinctions are operational: it accepts cookie or consent banners before capture and removes more than 60 known consent platforms, newsletter popups, and chat widgets; each step can be disabled. Bot checks or CAPTCHAs, blank pages, timeouts, failed loads, and cache hits are not billed, and the response identifies the page verdict and billing status in X-Page-Verdict and X-Billed headers. Its MCP server provides take_screenshot, get_page_info, and capture_pdf tools for Claude, Cursor, and other MCP clients.

The Free plan includes 1,000 screenshots per month with no card. Paid plans are Starter ($5 for 3,000), Growth ($15 for 15,000), Pro ($39 for 60,000), Scale ($99 for 250,000), and Business ($249 for 1,000,000); yearly billing gives two months free, and every feature is available on every plan. Capture only what you need, choose a cache TTL for repeated URLs, and resize the resulting image before the GitHub upload.

Sign up for the free ScreenshotNeo plan to try 1,000 screenshots a month without adding a card.

Practical checklist before you publish the link

• The exported file is PNG, JPG, or GIF and under 1 MB.
• The canvas is at least 640 × 320 pixels; 1280 × 640 is preferred.
• The title and logo remain readable at thumbnail size.
• You tested transparent artwork on light and dark backgrounds, or selected a solid background.
• The image is uploaded in the correct repository’s Settings → Social preview section.
• You opened the public repository page and confirmed the new image is shown there.

Bottom line

Create a 1280 × 640 image under 1 MB, upload it through the repository’s Social preview settings, and use a solid background unless you have verified that transparency works for your audience. For a fast source image from a live repository page, ScreenshotNeo can automate the capture before you finish the design and upload.

Quick Recap

Bestseller No. 1

125 avgrafx 3x2 Rectangle Custom Personalized Stickers Labels: Vinyl Waterproof, Dishwasher Safe Made in USA - Logo, Text, Image for Car Sticker Printer, Small Business Packaging Supplies

$37.99

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.