docs(readme): open with the katoptra mark, linked to the org - #9
Merged
Merged
Conversation
The header every katoptra README shares: the mark served from katoptra.org, linked to https://github.com/katoptra so a clone leads back to the organization, the repository name, one line of what it does, and the badges centered beneath. The mark is the light and dark pair from katoptra/site, chosen by prefers-color-scheme.
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 README opens with the shared katoptra header: the mark, linked to https://github.com/katoptra so anyone who lands in a clone is led back to the organization, then the repository name, one line of what it does, and the existing badges centered beneath. Nothing below the header changes.
The mark is served from katoptra.org as a light and a dark PNG, picked by
prefers-color-schemethrough a<picture>element, so there is no copy of the artwork in this repository.Depends on
katoptra/site#11, which publishes
https://katoptra.org/brand/katoptra-mark-224.pngand-dark-224.png. Merge that first, or the image is a broken link until it deploys.Test plan