Component
DocsCard
A page in a docs index — the whole card is the link.
import { DocsCard } from '@loidolt/theme-docs';
Example
Notes
- External links open in a new tab and say so to assistive tech.
Props
Generated from the component source, so it cannot drift from the implementation.
| Prop | Type | Default | Notes |
|---|---|---|---|
href required | string | — | |
title required | string | — | |
children | Snippet | — | Anything else inside the card, below the description. |
class | string | — | |
description | string | — | |
external | boolean | false | Opens in a new tab, and says so to assistive tech. |
externalLabel | string | '(opens in a new tab)' | |
eyebrow | string | — | A short label above the title, e.g. a category. |
headingLevel | HeadingLevel | 3 |