Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms.
You can upload an image to a private repository, but your image can only be shared from a public repository.
Tip: Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at 640 by 320 pixels.
On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Settings.
Under "Social preview," click Edit
- To add a new image, click Upload an image....
- To remove an image, click Remove image
We support PNG images with transparency. Many communication platforms support a dark mode, so using a transparent social preview may be beneficial. The transparent image below is acceptable on a dark background; however, this may not always be the case.
When using an image with transparency, keep in mind how it may look on different color backgrounds or platforms that don't support transparency.
Tip: If you aren't sure, we recommend using an image with a solid background.