jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 21:04:17 -05:00
Code Issues Projects Releases Wiki Activity

Add transparency information to social preview docs (#16418)

Browse Source 
* Add transparency information to social preview docs

* Apply suggestions from code review

* Adding heading

* Update content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md

* Fixing 1st tip

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
Co-authored-by: Ramya Parimi <33761166+ramyaparimi@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
This commit is contained in:
Anthony Swierkosz
2022-04-05 09:31:36 -07:00
committed by GitHub
parent e5fb3dce89
commit d6e8e4ac9d
2 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/help/repository/social-preview-transparency.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 197 KiB

19
content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
View File

@@ -16,10 +16,14 @@ shortTitle: Social media preview
---
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.
## Adding an image to customize the social media preview of your repository
{% ifversion not ghae %}You can upload an image to a private repository, but your image can only be shared from a public repository.{% endif %}
{% tip %}
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.
**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.
{% endtip %}
{% data reusables.repositories.navigate-to-repo %}
@@ -29,3 +33,16 @@ Tip: Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the be
- To remove an image, click **Remove image**
![Social preview dropdown](/assets/images/help/repository/social-preview.png)
## About transparency
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 %}
**Tip:** If you aren't sure, we recommend using an image with a solid background.
{% endtip %}
![Social preview transparency](/assets/images/help/repository/social-preview-transparency.png)