LinkCard

LinkCard is Card's "always a link" cousin. Renders as an <a> with a trailing right-arrow glyph and a hover accent. Use it for cross-references and next-step tiles.

Basic use

<LinkCard Title="Quick start" Description="Scaffold a fresh site and see it running in ~5 minutes." Href="/docs/getting-started/quick-start" />

External

Set External="true" for outbound links : adds target="_blank" and rel="noopener".

<LinkCard Title="ShellDocs on GitHub" Description="Source, issues, releases." Href="https://github.com/shellui-dev/shelldocs" External="true" />

In a grid

The canonical use : pair with CardGrid for prev/next-style "keep reading" tiles at the bottom of a page.

<CardGrid Columns="2">
<LinkCard Title="Configuration" Description="Site title, brand logo, sidebar variant, package selector." Href="/docs/getting-started/configuration" />
<LinkCard Title="Project structure" Description="What shelldocs init created, what each folder does." Href="/docs/getting-started/project-structure" />
</CardGrid>

Props

Prop Type Default Description
HrefRequired string "#" Target URL. Required : LinkCard is always a link.
Title string? — Title, bold, primary color.
Description string? — Short muted description below the title.
External bool false When true, adds target='_blank' and rel='noopener'.

LinkCard vs Card

Prop Type Default Description
Always a link LinkCard — Href is required. The trailing arrow signals click affordance visually.
Sometimes a link Card — Href is optional : renders as a link when set, a plain block otherwise. No arrow glyph.
Rich body Card — Card accepts ChildContent for lists, code blocks, nested components. LinkCard is title + description only.
Icon slot Card — Only Card renders an IconSvg above the title.

See also