Link cards
A cross-reference that deserves a larger target than an inline link, in a grid of one or two columns.
- #authoring
- #components
- #navigation
For the end of a note, where the question is what to read next. A card carries a title, a line of description and an eyebrow naming where it leads, so the reader chooses between destinations rather than guessing from four words of link text.
<CardGrid> lays them out in two columns on a wide screen and one on a narrow
one. A single card is fine, and three read as a list of equals. That is the
point, so do not use cards to rank.
Inside the prose
Cards interrupt reading, so they belong at a stopping point, which is the end of a section or the end of the note. A reference made in passing stays an inline link, which keeps the sentence intact.
Props
<LinkCard />
hrefstring
Internal route or external URL. Internal routes are validated at build time.
titlestring
The destination's name, usually its title.
description?string
One line on why to follow it.
eyebrow?string
Short label above the title, usually the destination's domain.
Related entries
Callouts
Semantic notices for a caveat, a tip or a danger, with the five types and when each is honest.
Steps
A numbered procedure whose rail survives the code blocks inside it.
Tabs
One panel per alternative, with keyboard navigation and a shared choice across the document.