/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog

Cards

Card and CardGroup components for navigation and feature highlights.

3 min read

Cards are versatile components for navigation, feature lists, and content organization.

Basic Card

mdx
<Card title="Quick Start" href="/guides/quickstart">
Get up and running in under 5 minutes.
</Card>
Quick Start
Get up and running in under 5 minutes.

Card with Icon

mdx
<Card title="Authentication" icon="key" href="/api-reference/authentication">
Learn how to authenticate API requests.
</Card>
Authentication
Learn how to authenticate API requests.

CardGroup

Arrange cards in a grid:

mdx
<CardGroup cols={2}>
<Card title="Installation" icon="download" href="/guides/quickstart">
Install the CLI
</Card>
<Card title="Configuration" icon="settings" href="/configuration/syntext-json">
Configure your project
</Card>
</CardGroup>

Three-Column Layout

mdx
<CardGroup cols={3}>
<Card title="REST API" icon="code">
HTTP endpoints
</Card>
<Card title="GraphQL" icon="search">
Query language
</Card>
<Card title="WebSocket" icon="zap">
Real-time events
</Card>
</CardGroup>
REST API
HTTP endpoints
GraphQL
Query language
WebSocket
Real-time events

Without Description

Cards can be title-only for compact navigation:

mdx
<CardGroup cols={4}>
<Card title="SDKs" href="/sdks/overview" />
<Card title="TypeScript" href="/sdks/typescript" />
<Card title="CLI" href="/cli/overview" />
<Card title="MCP" href="/guides/mcp-integration" />
</CardGroup>

Link to external sites:

mdx
<Card title="GitHub" icon="github" href="https://github.com/yourorg">
View source code and contribute.
</Card>

External links open in the same tab, like internal ones.

Card Props

PropTypeDescription
titlestringCard heading
hrefstringLink destination
ctastringCall-to-action text with a trailing arrow, pinned to the card foot so cards in a row align
methodsstringComma-separated HTTP methods rendered as coloured chips at the card foot, e.g. POST,GET
eyebrowstringSmall uppercase label above the title, e.g. Guide
iconstringA name from the icon set below, or an emoji. An unknown name renders no icon
childrenMarkdownDescription text. Optional: <Card title="..." href="..." /> is a title-only card

CardGroup Props

PropTypeDefaultDescription
cols1 | 2 | 3 | 4auto-fitNumber of columns. Omit it to fit as many cards per row as will fit at a 16rem minimum width
childrenCard[]—Card components

Available Icons

The icon prop accepts these names: alert-circle, api, arrow-right, bar-chart, bell, book, bot, box, briefcase, building, calendar, camera, chart, check, clock, cloud, code, columns, compass, cpu, credit-card, database, download, eye, file-text, fingerprint, flag, flame, folder, git-branch, github, globe, graduation-cap, hammer, heart, help, home, key, layers, layout, lightbulb, link, list-ordered, lock, mail, map, message-square, mic, monitor, package, palette, phone, play, plug, puzzle, refresh, rocket, search, send, settings, shield, signal, sliders, sparkles, star, terminal, upload, users, video, wallet, webhook, wrench, zap.

An emoji also works. Any other name renders no icon instead.

Note

Every name in the list above draws on doc engine v1 and v2 alike — in Card, Accordion, Step and Tab icons, <Icon>, header tab icons and page icon frontmatter in the sidebar. v2 also draws the language glyphs typescript, javascript, python, go, ruby, php, java, bash, shell, rust, curl and file, and adds alert-triangle, alert-octagon, check-circle, info, server, user, history, image, megaphone, pencil, tag and trash, among others. An unknown name draws nothing.

Use Cases

Feature Overview

Fast Builds
Build 500 pages in under 5 seconds
AI Assistant
Built-in chat powered by your docs
Global CDN
Sub-50ms response times worldwide

SDK Selection

Was this page helpful? Yes No
Previous
Next
Product
Resources
Company
© 2026 SyntextBuilt with Syntext