页面

shadcn-docs-nuxt 中使用的前言属性.

---
title: Front Matter
description: Front matter attributes used in shadcn-docs-nuxt.
icon: lucide:book-type

navTruncate: false
navBadges:
  - value: New
    type: lime

badges:
  - value: Docus
    to: https://docus.dev/api/components#alert
    target: _blank
  - value: Source
    icon: lucide:code
    to: https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/components/content/Alert.vue
    target: _blank

authors:
  - name: Tony Zhang
    username: ZTL-UwU
    avatar: https://www.github.com/ZTL-UwU.png
    to: https://github.com/ZTL-UwU
    target: _blank
---

<!-- Content of the page -->

展示

badges:
  - value: 0.8.10
  - value: Source
    icon: lucide:code
    to: https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/components/content/FileTree.vue
    target: _blank

参数

titlestring
页面标题, 默认为文件名.
descriptionstring
页面描述. 默认为页面的第一个 <p> 标签的内容.
navigationboolean
true
定义页面是否包含在侧边栏中. 在 index.md 中将其设置为 false.
iconstring
侧边栏中显示的页面图标.
navBadges[]
一个附加在侧边栏链接末尾的徽章列表.
navTruncateboolean
true
是否截断侧边栏标题.
badges[]
在页面标题下方显示的徽章列表.
authors[]
在页面标题下方显示的作者列表.
tocboolean
true
是否显示此页面的目录部分.
asideboolean
true
是否显示此页面的侧边栏部分.
editLinkboolean
true
是否显示此页面的编辑链接.
prevNextboolean
true
是否显示上一页和下一页按钮.
breadcrumbboolean
true
是否显示面包屑导航.
fullpageboolean
false
是否像主页一样使用全屏布局. 示例.
编辑此页面
Markdown
如何使用 MDC 语法编写文档.
文件夹
通过 _dir.yml 文件配置目录节点.