MDC Components

Embed Nuxt UI prose components in Markdown with MDC syntax, including callouts, badges, cards, accordions, tabs, steps, fields, icons and keyboard keys, to structure richer docs without writing Vue code.
View source

MDC syntax lets you use Vue components in Markdown: block components are written ::name, inline components :name, props go in {} or a YAML block, and each nesting level adds one more colon.

This page covers the prose components most useful in docs. Any globally registered Vue component works in Markdown the same way; see the Nuxt UI docs for the full list.

Callout

Callouts highlight information that sits alongside the main text. note, tip, warning and caution are shortcuts with a preset icon and color:

The page title comes from the title frontmatter field, so the body starts at level two.
Changes to app.config.ts do not require restarting the dev server.
The MCP Server cannot be disabled while AI Chat is enabled.
Never commit NUXT_GITHUB_TOKEN to a public repository.
::

## `Icon`

`icon` renders any [Iconify](https://icones.js.org/) icon, named `i-{collection}-{icon}`:

::code-preview
:icon{name="i-simple-icons-nuxtdotjs" class="size-6"} :icon{name="i-lucide-book-open" class="size-6"}

#code
```mdc
:icon{name="i-simple-icons-nuxtdotjs" class="size-6"} :icon{name="i-lucide-book-open" class="size-6"}

::

Kbd

kbd shows a keyboard key. meta renders as ⌘ on macOS and Ctrl elsewhere:

Press Ctrl K to open search.
Press :kbd{value="meta"} :kbd{value="K"} to open search.
Copyright © 2024 - 2026