Skip to content

Commit d6e8e4a

Browse files
aisgbnokmchammer01ramyaparimiheiskr
authored
Add transparency information to social preview docs (#16418)
* 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 <[email protected]> Co-authored-by: Ramya Parimi <[email protected]> Co-authored-by: Kevin Heis <[email protected]>
1 parent e5fb3dc commit d6e8e4a

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed
Loading

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@ shortTitle: Social media preview
1616
---
1717
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.
1818

19+
## Adding an image to customize the social media preview of your repository
20+
1921
{% ifversion not ghae %}You can upload an image to a private repository, but your image can only be shared from a public repository.{% endif %}
2022

2123
{% tip %}
22-
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.
24+
25+
**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.
26+
2327
{% endtip %}
2428

2529
{% 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
2933
- To remove an image, click **Remove image**
3034

3135
![Social preview dropdown](/assets/images/help/repository/social-preview.png)
36+
37+
## About transparency
38+
39+
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.
40+
41+
When using an image with transparency, keep in mind how it may look on different color backgrounds or platforms that don't support transparency.
42+
43+
{% tip %}
44+
45+
**Tip:** If you aren't sure, we recommend using an image with a solid background.
46+
{% endtip %}
47+
48+
![Social preview transparency](/assets/images/help/repository/social-preview-transparency.png)

0 commit comments

Comments
 (0)