Skip to main content
All components are available in every MDX page without imports. Unknown components never break a build. They render as inert placeholders and are collected into the build report, so pseudo-tags like <YOUR_API_KEY> in prose are safe.

Callouts

<Note>, <Info>, <Tip>, <Check>, <Warning>, <Danger>, plus a generic <Callout icon="…" color="…">.

Cards and columns

Card supports icon, href, img, horizontal, cta, arrow, and a callout-style type. Columns/Column give you bare multi-column layout.

Tabs

Tabs with the same titles sync their selection across the page by default (sync={false} to opt out).

Steps

Accordions and expandables

<Expandable title="Show details"> is the inline variant.

Code groups and API examples

<CodeGroup> renders multiple fenced code blocks as one tabbed block. <RequestExample> and <ResponseExample> pin their content into the right-hand examples rail on API pages, as does <Panel>.

Media

Images get click-to-zoom by default (noZoom disables it). Add an actions attribute for copy/download buttons (actions="copy" to pick one, actionsPlacement to position them). <Image size="md" border background> adds sizing and framing.

API fields

Changelog entries

<Update> labels appear in the table of contents. When any entry has tags, the table of contents becomes a tag filter instead, and the selection is mirrored into a shareable ?tags= URL. With rss: true frontmatter the page publishes an RSS feed; a per-entry rss={{ title, description }} prop overrides that feed item.

File trees

Everything else

  • <Icon icon="rocket" size={20}> for standalone icons.
  • <Tooltip tip="…"> and <Badge> for inline annotations.
  • <Tile> and <Prompt> for link tiles and copyable AI prompts.
  • <View title="…"> for multi-view content behind a dropdown.
  • <Color> swatches with click-to-copy values.
  • <Visibility for="agents"> renders content only in the Markdown/agent exports; for="humans" renders it only on the web page.
  • Math renders through $…$ and $$ … $$. See Code blocks.

Heading anchors

Every heading gets an anchor link with a Mintlify-compatible slug; duplicates get -2, -3 suffixes. Write ## Title {#custom-id} to set your own id, and add noAnchor to a heading to keep the id but hide the anchor chip.

Snippets and custom components

Reusable content lives in snippets/. See Snippets & variables. You can also ship your own React components as .jsx files in the repository and import them from MDX.