Repository navigation
docs(site): show every hero, frame and readme layout - #16
Merged
Merged
Conversation
…readme layout Variant configs in site/gallery/variants/ reuse the raw captures, and showcase readme prints each layout and the kit README table to site/gallery/readme/.
…mes and readme guides
…the 0.3.0 outputs
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.
0.3.0 added six hero layouts, three frame styles, three backgrounds and five README layouts. The docs described them in tables but showed none of them, and the root README had no images and still described the 0.2 outputs. This PR renders every option from the gallery fixture and shows it.
How the images are made
bun run docs:gallerynow also runs 19 small variant configs insite/gallery/variants/(the web or tty config with one block changed,root: '..'). They runshowcase heroorshowcase frameon the raw captures the existing steps wrote, so nothing is captured twice.showcase readme --layout <name>runs once per layout with the web config, and its standard output is written tosite/gallery/readme/<name>.html(committed, the pages import them).site/gallery/readme.config.mjsonly lists gallery images:showcase readmeprints the table in the root README from it.git statusclean, and every existing output and manifest entry is byte for byte unchanged (the manifest diff is additions only).What each page shows now
browser, and five backgrounds), and "README layouts" (each snippet as a live preview styled like a GitHub README, next to the raw HTML). Every tile has the image, the option name, the default marked, and the config block cut from the file that made it.showcase readmementions--layout.README
browserframe, printed byshowcase readme. Captions and alt text say the images are Nightjar, the gallery fixture app.https://noctcore.github.io/showcase-kit/gallery/...) so they render on npm too. The images appear once this merge deploys the site, and on npm with the next release.site/public/, and when the README table drifts from whatshowcase readmeprinted.gh api markdown(gfm, context noctcore/showcase-kit): everywidth,align,<sub>,<h3>,<details>,<summary>and<img>survives.Budget
Committed gallery files: 1031.2 KB before, 1791.1 KB after, budget 4096.0 KB (unchanged). The variants are sized for a docs tile (
maxWidth: 1200,quality: 80for web frames).No change to
src/,test/, lockfiles or dependencies, and no changeset (docs only).