Blog
Jan 20, 2025 - 8 MIN READ
Nuxt UI Prose Components Reference Guide

Nuxt UI Prose Components Reference Guide

A comprehensive reference guide for all Nuxt UI components that can be used in markdown files with MDC syntax.

Muhammad Shafayat Oshman

Muhammad Shafayat Oshman

This is my personal reference guide for all the MDC (Markdown Components) that can be used in Nuxt Content markdown files. Each section shows the syntax and live output.


Callouts

Callouts are used to highlight important information.

Note Callout

::callout
This is a default note callout.
::
This is a default note callout.

Callout with Icon

::callout{icon="i-lucide-lightbulb"}
This callout has a custom lightbulb icon.
::
This callout has a custom lightbulb icon.

Warning Callout

::callout{icon="i-lucide-alert-triangle" color="warning"}
**Warning:** This is an important warning message.
::
Warning: This is an important warning message.

Error Callout

::callout{icon="i-lucide-x-circle" color="error"}
**Error:** Something went wrong!
::
Error: Something went wrong!

Success Callout

::callout{icon="i-lucide-check-circle" color="note"}
**Success:** Operation completed successfully.
::
Success: Operation completed successfully.

Info Callout

::callout{icon="i-lucide-info" color="info"}
**Info:** Here's some helpful information.
::
Info: Here's some helpful information.

Code Blocks

Basic Code Block

```javascript
const greeting = "Hello, World!";
console.log(greeting);
```
const greeting = "Hello, World!";
console.log(greeting);

Code Block with Filename

```typescript [nuxt.config.ts]
export default defineNuxtConfig({
  modules: ['@nuxt/content', '@nuxt/ui']
})
```
nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/content', '@nuxt/ui']
})

Code Block with Line Highlights

```vue{3,5-7}
<template>
  <div>
    <h1>Highlighted Line</h1>
    <p>Normal line</p>
    <p>Highlighted</p>
    <p>Highlighted</p>
    <p>Highlighted</p>
  </div>
</template>
```
<template>
  <div>
    <h1>Highlighted Line</h1>
    <p>Normal line</p>
    <p>Highlighted</p>
    <p>Highlighted</p>
    <p>Highlighted</p>
  </div>
</template>

Code Groups

Display multiple code blocks in tabs:

::code-group
```bash [npm]
npm install @nuxt/content
```
```bash [pnpm]
pnpm add @nuxt/content
```
```bash [yarn]
yarn add @nuxt/content
```
::
npm install @nuxt/content

Cards

Basic Card

::card
---
title: Card Title
---
This is the card content. You can add any markdown here.
::

Card Title

This is the card content. You can add any markdown here.

Card with Icon

::card
---
title: Features
icon: i-lucide-sparkles
---
Discover all the amazing features.
::

Features

Discover all the amazing features.


Card Group

::card-group
  ::card
  ---
  title: Documentation
  icon: i-lucide-book-open
  to: https://content.nuxt.com
  target: _blank
  ---
  Read the full documentation.
  ::
  ::card
  ---
  title: Examples
  icon: i-lucide-code
  to: https://content.nuxt.com/templates
  target: _blank
  ---
  Browse example projects.
  ::
  ::card
  ---
  title: GitHub
  icon: i-lucide-github
  to: https://github.com/nuxt/content
  target: _blank
  ---
  View source code.
  ::
::

Documentation

Read the full documentation.

Examples

Browse example projects.

GitHub

View source code.


Collapsible / Accordion

::collapsible
---
title: Click to expand
---
This content is hidden by default and reveals when clicked.
::

Field

Display form field documentation:

::field
---
name: email
type: string
required: true
---
The user's email address.
::
email
string required
The user's email address.

Field Group

::field-group
  ::field
  ---
  name: username
  type: string
  required: true
  ---
  The unique username.
  ::
  ::field
  ---
  name: password
  type: string
  required: true
  ---
  The user password.
  ::
::
username
string required
The unique username.
password
string required
The user password.

Tabs

::tabs
  ::div
  ---
  label: Tab 1
  icon: i-lucide-home
  ---
  Content for the first tab.
  ::
  ::div
  ---
  label: Tab 2
  icon: i-lucide-settings
  ---
  Content for the second tab.
  ::
::

Content for the first tab.


Steps

Add the Nuxt UI module in your nuxt.config.ts

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui']
})

Import Tailwind CSS in your CSS

assets/css/main.css
@import "tailwindcss";

Start your development server

npm run dev

Icons

Use Lucide icons inline:

:icon{name="i-lucide-heart"} Love this feature!

:icon{name="i-lucide-star" class="text-yellow-500"} Starred!

Love this feature!

Starred!


Badges

:badge[New]{variant="solid" color="info"}
:badge[Beta]{variant="outline" color="warning"}
:badge[Deprecated]{variant="soft" color="error"}
NewBetaDeprecated

Standard Markdown Elements

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Text Formatting

**Bold text**
*Italic text*
~~Strikethrough~~
`inline code`

Bold text | Italic text | Strikethrough | inline code

Blockquotes

> This is a blockquote.
> It can span multiple lines.

This is a blockquote. It can span multiple lines.

Lists

- Unordered item 1
- Unordered item 2
  - Nested item

1. Ordered item 1
2. Ordered item 2
  • Unordered item 1
  • Unordered item 2
    • Nested item
  1. Ordered item 1
  2. Ordered item 2

Tables

| Feature | Status |
|---------|--------|
| SSR | ✅ |
| SSG | ✅ |
| ISR | ✅ |
FeatureStatus
SSR
SSG
ISR
[External Link](https://nuxt.com)
[Internal Link](/about)

External Link | Internal Link

Images

![Alt text](/path/to/image.jpg)

Useful Icon Names

Common Lucide icons you can use:

  • i-lucide-info - Information
  • i-lucide-alert-triangle - Warning
  • i-lucide-check-circle - Success
  • i-lucide-x-circle - Error
  • i-lucide-lightbulb - Tip/Idea
  • i-lucide-book-open - Documentation
  • i-lucide-code - Code
  • i-lucide-terminal - Terminal
  • i-lucide-github - GitHub
  • i-lucide-external-link - External link
  • i-lucide-copy - Copy
  • i-lucide-download - Download
  • i-lucide-settings - Settings
  • i-lucide-star - Star/Favorite
  • i-lucide-heart - Heart/Like

Color Options

Available colors for callouts, badges, and other components:

  • primary (default blue)
  • neutral (gray)
  • red
  • orange
  • amber
  • yellow
  • lime
  • green
  • emerald
  • teal
  • cyan
  • sky
  • blue
  • indigo
  • violet
  • purple
  • fuchsia
  • pink
  • rose
© 2026 Muhammad Shafayat Oshman