docs: add social preview header to assets - #12
Merged
Conversation
The 1280x640 image uploaded under Settings -> Social preview now lives in the repository, together with the vector source it is rendered from, so it can be regenerated when the tagline or the mark changes. The header inlines assets/logo.svg so the two stay in sync by construction. GitHub does not serve the social preview from the repository; a maintainer uploads it once in the repository settings.
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.
What
The GitHub social preview image now lives in the repository alongside the
vector source it is rendered from.
assets/social-header.svg— 1280×640 vector source: theassets/logo.svgmark (inlined, so the file stands alone and cannot drift from the logo), the
bugwardenwordmark in slate#56656Fwith an amber#D89327rule, and thetagline, on the
#F5F3EAproject background.assets/social-header.png— the PNG rendered from that SVG, byte-for-bytereproducible with the headless-Chromium command recorded in the SVG header
comment.
Notes
upload under Settings → Social preview. Keeping the artwork in-tree means
the next person to change the tagline has the source instead of a flat PNG.
meant to be shown twice.