E
简单文档
开始写作

页面

Estel Docs 中使用的front matter属性。
---
title: Front Matter
description: Estel Dsoc中使用的front matter属性。
icon: lucide:book-type

navBadges:
  - value: New
    type: lime

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

展示

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

参数

title
string
页面标题。默认为文件名。
description
string
页面描述。默认为页面的第一个 <p>。
navigation
boolean
定义页面是否包含在侧边栏中。在 index.md 中设置为 false。
icon
string
在侧边栏中为页面显示的图标。
navBadges
[]
附加到侧边栏链接末尾的徽章列表。
navTruncate
boolean
是否截断侧边栏标题。
badges
[]
显示在页面标题底部的徽章列表。
authors
[]
显示在页面标题底部的作者列表。
toc
boolean
是否为此页面显示目录部分。
aside
boolean
是否为此页面显示侧边栏部分。
editLink
boolean
是否为此页面显示编辑链接。
prevNext
boolean
是否显示上一页和下一页按钮。
breadcrumb
boolean
是否显示面包屑导航。
fullpage
boolean
是否使用像主页一样的全页面布局。示例。