---
title: Components Overview
description: >-
  Explore Jamdesk's MDX components, including cards, tabs, callouts, and code
  blocks, to find the right fit for your documentation content.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

Jamdesk includes MDX components you can use in any page. This overview helps you choose the right component for your content.

## Usage

Drop components directly into your MDX:

```mdx
<Card title="Quickstart" icon="rocket" href="/quickstart">
  Launch your docs in minutes.
</Card>
```

## Layout & Navigation

<Columns cols={3}>
  <Card title="Accordion" icon="chevron-down" href="/components/accordion">
    Collapsible content sections that let users expand only what they need. Ideal for FAQs, feature lists, and configuration options.
  </Card>
  <Card title="Card" icon="square" href="/components/card">
    Learn to use the Card component to build clickable, styled containers with icons, images, links, and CTAs in grid layouts.
  </Card>
  <Card title="Columns" icon="columns" href="/components/columns">
    Responsive grid layout for displaying Cards, Tiles, and other content side by side. Automatically adapts to screen size.
  </Card>
  <Card title="Frame" icon="image" href="/components/frame">
    Frame wraps images and demos in a bordered container with optional captions, keeping documentation visuals consistent.
  </Card>
  <Card title="Panel" icon="sidebar" href="/components/panel">
    Use Panel to pin custom content like warnings or quick references in the sidebar, keeping it visible while readers scroll.
  </Card>
  <Card title="Steps" icon="list-ol" href="/components/steps">
    Numbered step-by-step guides for setup flows, tutorials, and troubleshooting. Supports icons, code blocks, and nested content.
  </Card>
  <Card title="Tabs" icon="folder" href="/components/tabs">
    Switchable panels for mutually exclusive content like package managers or languages. Matching tab titles sync across the entire page.
  </Card>
  <Card title="Tile" icon="grid-2" href="/components/tile">
    Tiles display content previews with a styled pattern background and prominent image area. Use them for integrations, templates, or visual galleries.
  </Card>
  <Card title="Tree" icon="folder-tree" href="/components/tree">
    Display file and folder hierarchies with interactive expand/collapse and keyboard navigation. Ideal for project structure documentation.
  </Card>
</Columns>

## Content & Emphasis

<Columns cols={3}>
  <Card title="Badge" icon="tag" href="/components/badge">
    Inline labels for status, categories, and metadata -- 11 color variants, 4 sizes, icons, pill/rounded shapes, and stroke outlines.
  </Card>
  <Card title="Callouts" icon="circle-info" href="/components/callouts">
    Learn how to use Note, Tip, Warning, Danger, Check, and custom Callout components to highlight key information in your docs.
  </Card>
  <Card title="Expandable" icon="expand" href="/components/expandable">
    Expandable creates a simple show/hide toggle for content that readers may want to see but isn't essential to the main flow.
  </Card>
  <Card title="Tooltip" icon="message" href="/components/tooltip">
    Display definitions and context on hover. Define terms, explain acronyms, or link to related content without cluttering the page.
  </Card>
  <Card title="Update" icon="clock-rotate-left" href="/components/update">
    Timeline-style changelog entries with dates, descriptions, and category tags. Integrates with your Table of Contents for navigation.
  </Card>
</Columns>

## Code & Data

<Columns cols={3}>
  <Card title="CodeGroup" icon="layer-group" href="/components/code-group">
    Display code blocks in a tabbed interface. Show the same operation in multiple languages like cURL, Python, and JavaScript.
  </Card>
  <Card title="Examples" icon="code" href="/components/examples">
    Pin code blocks in a sticky right sidebar on desktop so readers can reference them while scrolling. Supports tabbed languages.
  </Card>
  <Card title="Fields" icon="list" href="/components/fields">
    Document API parameters and response fields with ParamField and ResponseField components. Supports types, defaults, and nested objects.
  </Card>
  <Card title="Tables" icon="table" href="/components/tables">
    Organize data into rows and columns. Supports markdown tables and Table components with sorting, highlighting, and spanning.
  </Card>
</Columns>

## Diagrams & Visuals

<Columns cols={3}>
  <Card title="Color" icon="palette" href="/components/color">
    The Color component displays color palettes for documenting design systems, brand guidelines, or any color specification.
  </Card>
  <Card title="Mermaid Diagrams" icon="diagram-project" href="/components/mermaid">
    Render flowcharts, sequence diagrams, timelines, pie charts, and more from text-based Mermaid syntax. Diagrams are built as SVG at build time.
  </Card>
  <Card title="D2 Diagrams" icon="diagram-project" href="/components/d2">
    Render architecture diagrams, flowcharts, sequences, and SQL models from text-based D2 syntax. Diagrams render as SVG with automatic light and dark theming.
  </Card>
</Columns>

## Advanced

<Columns cols={3}>
  <Card title="EmailSubscribe" icon="envelope" href="/components/email-subscribe">
    Add a newsletter or changelog signup form to any docs page with the EmailSubscribe component: native capture for seven providers, embeds for the rest.
  </Card>
  <Card title="Prompt" icon="wand-magic-sparkles" href="/components/prompt">
    Use Prompt to present reusable AI instructions with copy, built-in open-in actions, custom destinations, icons, and compact display options.
  </Card>
  <Card title="Visibility" icon="eye" href="/components/visibility">
    Show different content to human readers and AI agents on the same page. Agent-only context, instructions, and definitions that stay out of the rendered docs.
  </Card>
  <Card title="View" icon="window-maximize" href="/components/view">
    Create documentation that adapts to the reader's framework or language choice. Entire sections switch based on user selection.
  </Card>
  <Card title="Widget" icon="bullhorn" href="/components/widget">
    Embed a live What's New widget demo in your docs with the Widget MDX component: a trigger button that opens your changelog in a modal, no script tag needed.
  </Card>
</Columns>
