Link card

A card with a title, description, a primary link list, and an optional aside. It is designed to sit inside a {card-group}, and it renders standalone too.

See the docs-builder documentation hub for both rendering modes on one page.

:::{link-card}
title: Writing content
link: /getting-started/writing-content.md
description: Author a page, add links, and preview it locally.
links:
  - label: Pages and links
    url: /getting-started/pages-and-links.md
  - label: Syntax guide
    url: /syntax/index.md
:::
		

The body is YAML, not markdown. The directive expects a fixed schema and renders it, so an author fills in fields rather than writing markup. A missing title or invalid YAML fails the build.

title: Writing content
link: /getting-started/serve.md
description: One short blurb.
icon: elasticsearch
variant: es
links:
  - label: Pages and links
    url: /getting-started/pages-and-links.md
aside:
  label: Build types
  links:
    - label: Isolated
      url: /documentation/isolated/configure/index.md
    - label: Assembler
      url: /documentation/assembler/index.md
		

1. required, the card heading
2. optional, makes the title clickable
3. optional
4. optional, product-keyed inline SVG
5. optional accent: es, obs, or sec
6. optional, the primary link list
7. optional bottom rail

variant: es, obs, or sec adds a left border in the matching solution colour. Use it for solution cards.

icon takes the same product keys as {hero}: elasticsearch, kibana, observability, security.

Nested in an {explore} section, through a {card-group} ancestor, the same YAML renders as a titled link column instead of a bordered card. Two things change:

• description is dropped. A column is a pure link index.
• aside renders as a badge cluster under its own label, rather than an inline dot-separated list.

The aside label is authored. There is no fixed label text.

Every link, every entry in links, and every entry in aside.links validates at build time. Use one of these forms:

A relative path such as foo.md is rejected. Prefer a cross-link scheme for any page outside the current repository. A site-absolute path that points into another repository's documentation set is validated nowhere.