Use inline code to display code snippets within text paragraphs. It's ideal for referencing code elements directly in sentences.
inline code
#code
`inline code`
::
Use code blocks to display multi-line code snippets with syntax highlighting. Code blocks are essential for presenting code examples clearly.
export default defineNuxtConfig({
modules: ['@nuxt/ui']
})
#code
```ts
export default defineNuxtConfig({
modules: ['@nuxt/ui']
})
```
::
When writing a code-block, you can specify a filename that will be displayed on top of the code block. An icon will be automatically displayed based on the extension or the name. Filenames help users understand the code's location and purpose within a project.
export default defineNuxtConfig({
modules: ['@nuxt/ui']
})
#code
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: ['@nuxt/ui']
})
```
::
app.config.ts through the ui.prose.codeIcon key:export default defineAppConfig({
ui: {
prose: {
codeIcon: {
terminal: 'i-ph-terminal-window-duotone'
}
}
}
})
Every code-block has a built-in copy button that will copy the code to your clipboard.
app.config.ts through the ui.icons.copy and ui.icons.copyCheck keys:export default defineAppConfig({
ui: {
icons: {
copy: 'i-lucide-copy',
copyCheck: 'i-lucide-copy-check'
}
}
})
To highlight lines of code, add {} around the line numbers you want to highlight.
Line highlighting is useful for focusing users on important parts of code examples.
export default defineAppConfig({
ui: {
icons: {
copy: 'i-lucide-copy',
copyCheck: 'i-lucide-copy-check'
}
}
})
#code
```ts [nuxt.config.ts]{4-5}
export default defineAppConfig({
ui: {
icons: {
copy: 'i-lucide-copy',
copyCheck: 'i-lucide-copy-check'
}
}
})
```
::
Group code blocks in tabs using code-group. code-group is perfect for showing code examples in multiple languages or package managers.
pnpm add @nuxt/ui
yarn add @nuxt/ui
npm install @nuxt/ui
bun add @nuxt/ui
#code
:::code-group
```bash [pnpm]
pnpm add @nuxt/ui
```
```bash [yarn]
yarn add @nuxt/ui
```
```bash [npm]
npm install @nuxt/ui
```
```bash [bun]
bun add @nuxt/ui
```
::
::
Display code blocks in a file tree view using code-tree. code-tree is excellent for showcasing project structures and file relationships.
export default defineAppConfig({
ui: {
colors: {
primary: 'sky',
colors: 'slate'
}
}
})
target: _blank to: https://ui.nuxt.com/getting-started/typography#codetree
Learn more about the code-tree component.
::
CodePreviewUse code-preview to show code output alongside the code. code-preview is ideal for interactive examples and demonstrating code results.
Write the code to be previewed in a the default slot and the actual code in the code slot.
class: "&>div:
class: "&>div:*
inline code
`inline code`
#code
::code-preview
`inline code`
#code
```mdc
`inline code`
```
::
::
CodeCollapseUse code-collapse for long code blocks to keep pages clean. code-collapse allows users to expand code blocks only when needed, improving readability.
@import 'tailwindcss';
@import '@nuxt/ui';
@theme {
--font-sans: 'Public Sans', sans-serif;
--breakpoint-3xl: 1920px;
--color-green-50: #effdf5;
--color-green-100: #d9fbe8;
--color-green-200: #b3f5d1;
--color-green-300: #75edae;
--color-green-400: #00dc82;
--color-green-500: #00c16a;
--color-green-600: #00a155;
--color-green-700: #007f45;
--color-green-800: #016538;
--color-green-900: #0a5331;
--color-green-950: #052e16;
}
#code
::code-collapse
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@theme {
--font-sans: 'Public Sans', sans-serif;
--breakpoint-3xl: 1920px;
--color-green-50: #EFFDF5;
--color-green-100: #D9FBE8;
--color-green-200: #B3F5D1;
--color-green-300: #75EDAE;
--color-green-400: #00DC82;
--color-green-500: #00C16A;
--color-green-600: #00A155;
--color-green-700: #007F45;
--color-green-800: #016538;
--color-green-900: #0A5331;
--color-green-950: #052E16;
}
```
::
::