内容组件
layer 在 Nuxt UI Prose 组件之外提供的内容组件:为元素添加入场动画的 Motion、动态星空背景 StarsBg,以及编辑式落地页使用的 LandingCover、LandingSection 等组件,均可直接在 Markdown 中使用。
除 MDC 组件 中的 Nuxt UI Prose 组件外,layer 在 components/content/ 中还提供下面这些可在 Markdown 中使用的组件。同目录下的 HighlightInlineType、HeaderToggleButton 供 Props 表格与页头内部使用,不建议在内容中直接引用。
Motion
Motion 基于 motion-v 的 Motion 组件,为包裹的内容添加入场动画。默认效果是从模糊、略微放大的状态淡入:
Movk Nuxt Docs:为 Nuxt 项目准备的编辑风文档主题。
::motion
**Movk Nuxt Docs**:为 Nuxt 项目准备的编辑风文档主题。
::
| Prop | 默认值 |
|---|---|
initial | { scale: 1.1, opacity: 0, filter: 'blur(20px)' } |
animate | { scale: 1, opacity: 1, filter: 'blur(0px)' } |
transition | { duration: 0.6, delay: 0.1 } |
其余 motion-v 的 Motion props 与 HTML 属性(如 class)原样透传。多个元素依次出现时,递增 transition.delay:
::motion
**构建现代文档**
::
::motion
---
transition: { duration: 0.6, delay: 0.3 }
---
基于 Nuxt 4 的文档主题。
::
::motion{class="flex gap-3"}
---
transition: { duration: 0.6, delay: 0.5 }
---
:::u-button{to="/docs/getting-started"}
开始使用
:::
::
StarsBg
StarsBg 在所在区块后方绘制三层缓慢上升的星点,用于落地页的首屏或收尾区块。它以绝对定位铺在父元素范围内,父元素需要设置 relative,并通过 isolate 建立层叠上下文:
::div{class="relative isolate h-48 overflow-hidden"}
:stars-bg
::
| Prop | 类型 | 默认值 | 说明 |
|---|---|---|---|
starCount | number | 300 | 三层星点的总数 |
color | string | 'var(--ui-primary)' | 星点颜色,接受任意 CSS 颜色 |
size | { min: number, max: number } | { min: 1, max: 2 } | 星点尺寸范围,单位 px |
:stars-bg{:star-count="120" color="var(--ui-text-muted)"}
星点位置按页面路由缓存,服务端与客户端渲染结果一致。系统开启「减少动态效果」时,星点动画会停止。
落地页组件
layer 内置一组编辑式落地页组件,本站首页与三套官方模板的首页都由它们组成。它们通常写在 content/index.md 中,每个组件占据整宽的一个区块:
| 组件 | 用途 | Props | 插槽 |
|---|---|---|---|
LandingCover | 封面:等宽眉题、双线、大标题、导语与右侧内容 | kicker、aside | title、description、links、default |
LandingIndex | 编号目录,由文档导航的顶层分区自动生成 | label | — |
LandingSection | 编号章节:左侧标题与说明,右侧特性网格 | index、kicker | title、description、links、aside、default |
LandingFeature | 特性网格中的一格,编号按出现顺序自动生成 | — | title、description |
LandingFigure | 带图注的配图,可分别指定亮暗两张图 | src、dark、alt、caption、label | — |
LandingClosing | 收尾大字与按钮 | — | title、links |
content/index.md
::landing-cover{kicker="文档" aside="MIT"}
#title
My Docs
#description
一句话介绍你的项目。
#links
:::u-button{to="/docs/getting-started" trailing-icon="i-lucide-arrow-right"}
快速开始
:::
#default
:landing-index{label="目录"}
::
::landing-section{index="01" kicker="Features"}
#title
主要特性
#description
用两三句话说明这一组特性。
#default
:::landing-feature
#title
特性一
#description
特性说明。
:::
::
::landing-closing
#title
从一个 Markdown 文件开始
#links
:::u-button{to="/docs/getting-started"}
开始使用
:::
::
在
nuxt.config.ts 的 runtimeConfig.public.version 中声明版本号后,LandingCover 会把它显示在眉题前,例如从 package.json 读取:version: pkg.version。