Repository navigation
docs: social preview image and npm/docs badges - #28
Merged
Merged
Conversation
Links shared on Discord, Reddit or X show GitHub's generic card unless the repository has a social preview. The SVG is the editable source; the PNG is what gets uploaded in the repository settings.
The package is now on npm and the site is online: the badges show at a glance that the project is published and maintained, and lead to both.
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
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.
Why
Improve how the project looks when someone lands on the repository or when a link to it is shared.
Changes
docs/images/social-preview.png(1280×640) and its editable SVG source. It must be uploaded manually: Settings → General → Social preview → Edit → Upload an image.Checks
prettier --check,docs:pages(no diff), lint and typecheck all pass.Generated by Claude Code