Repository navigation
docs: add social preview image to README - #21
Merged
Merged
Conversation
Shows in social link previews on Twitter/X, Discord, Slack, etc. when the repo URL is shared. GitHub picks up the first image in the README for its OpenGraph card automatically. Note: for the true GitHub repo social preview (the card that shows in search results, on stars, etc.), upload .github/social-preview.png manually via Settings → Social preview — that's not a git operation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the hero screenshot as the README's first image so it shows on social link previews when the repo URL is shared (Twitter/X, Discord, Slack, etc.).
For the true GitHub repo social card (shown in search results, on stars, in OG previews of the repo URL itself), upload
.github/social-preview.pngmanually via the repo's Settings → Social preview — that's not a git operation.Authorized by user: "open a pr and merge it directly".