estel_docs/content/docs/1.简单文档/3.writing/2.pages.md

title, description, navigation

title	description	navigation
页面	Estel Docs 中使用的front matter属性。	icon lucide:file-text

---
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
---

展示

:::tabs{variant="line"} ::stack{label="badges"}

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

::

::stack{label="authors"}

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

::

::stack{label="navBadges"}

navBadges:
  - value: New
    type: lime

:: :::

参数

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