基础知识

Markdown 组件

借助 Nuxt UI,使用 Markdown 组件帮助你组织内容。

Prose 组件是 HTML 排版标签的替代品。当你使用 Markdown 时,它们提供了一种简单的方式来定制你的界面。

Docus 和 Nuxt UI 提供了一套经过样式美化、外观精美的 Prose 组件,帮助你使用 MDC 语法 编写文档。

本页仅重点介绍最适合编写文档的 Prose 组件。但你可以在 Markdown 中使用 任意 Nuxt UI 或 Nuxt UI 组件。完整的可用组件列表,请参阅 Nuxt UI 文档。

Accordion(手风琴)

使用 accordionaccordion-item 组件在内容中显示一个 Accordion(手风琴)

Badge(徽章)

badge 组件的默认插槽中使用 Markdown,以在内容中显示一个 Badge(徽章)

v3.0.0

Callout(提示框)

callout 组件的默认插槽中使用 Markdown,为内容添加醒目的上下文提示。

使用 iconcolor 属性进行自定义。你也可以传递 <NuxtLink> 组件的任意属性。

此外,你还可以使用预设了图标和颜色的快捷方式:notetipwarningcaution

这里有一些额外信息供你参考。
这里有一条实用建议。
请谨慎执行此操作,因为它可能导致意外结果。
此操作无法撤销。

Card(卡片)和 CardGroup(卡片组)

card 组件的默认插槽中使用 Markdown,以突出显示你的内容。

使用 titleiconcolor 属性进行自定义。你也可以传递 <NuxtLink> 的任意属性。

将多个 card 组件包裹在 card-group 组件中,即可在网格布局中将它们分组展示。

Dashboard

一个多列布局的仪表盘。

SaaS

包含首页、定价、文档和博客的模板。

Docs

使用 @nuxt/content 构建的文档站点。

Landing

可作为起点的落地页模板。

Collapsible(可折叠区域)

使用 collapsible 组件包裹你的内容,以在文档中显示一个 Collapsible(可折叠区域)

Field(字段)和 FieldGroup(字段组)

field 用于在内容中展示某个属性或参数。你可以通过 field-group 将多个字段以列表形式分组。

analytics
boolean
默认为 false —— 为你的项目启用分析功能(即将推出)。
blob
boolean
默认为 false —— 启用 Blob 存储,用于保存静态资源,如图片、视频等。
cache
boolean
默认为 false —— 启用缓存存储,使用 Nitro 的 cachedEventHandlercachedFunction 缓存服务器路由响应或函数。
database
boolean
默认为 false —— 启用 SQL 数据库,用于存储应用程序数据。

Icon(图标)

使用 icon 组件在内容中显示一个 Icon(图标)

:icon{name="i-simple-icons-nuxtdotjs"}

Kbd(键盘按键)

使用 kbd 组件在内容中显示一个 Kbd(键盘按键)

:kbd{value="meta"} :kbd{value="K"}

Tabs(标签页)

使用 tabstabs-item 组件在内容中显示 Tabs(标签页)

::callout
Lorem velit voluptate ex reprehenderit ullamco et culpa.
::
::tabs{.w-full}
:::tabs-item{icon="i-lucide-code" label="代码"}
```mdc
::callout
Lorem velit voluptate ex reprehenderit ullamco et culpa.
::
```
::::

::::tabs-item{icon="i-lucide-eye" label="预览"}
:::::callout
Lorem velit voluptate ex reprehenderit ullamco et culpa.
:::::
::::
:::
::

Steps(步骤)

使用 Steps 组件包裹你的标题,以展示一系列步骤。

使用 level 属性指定用于步骤的标题层级。

创建一个全新的项目

Terminal
npm create nuxt@latest -- -t github:nuxt-content/docus

运行 docus CLI 启动开发服务器

Terminal
docus dev
© 2026 TATEN. All rights reserved.