Skip to content

Link Cards

Learn how to display links prominently as cards in Starlight.

To display links to different pages prominently, use the <LinkCard> component.

import { LinkCard } from '@astrojs/starlight/components';

Display a link prominently using the <LinkCard> component. Each <LinkCard> requires a title and an href attribute.

Add a short description to a link card using the description attribute.

Display multiple link cards side-by-side when there’s enough space by grouping them using the <CardGrid> component. See the “Group link cards” guide for an example.

Implementation: LinkCard.astro

The <LinkCard> component accepts the following props, as well as all other <a> element attributes:

required
type: string

The title of the link card to display.

required
type: string

The URL to link to when the card is interacted with.

type: string

An optional description to display below the title.