#Front Matter 配置

#title

• Type: string

页面的标题。默认情况下，页面的 h1 标题将用作 HTML 文档的标题。但是如果你想使用不同的标题，你可以使用 Front Matter 来指定页面的标题。例如：

---
title: 我的主页
---

#description

• Type: string

页面的自定义描述。例如：

---
description: 这是我的主页
---

#pageType

• Type: 'home' | 'doc' | 'api' | 'custom' | '404'
• Default: 'doc'

页面的类型。默认情况下，页面类型为doc。但是如果你想使用不同的页面类型，你可以使用pageType指定页面类型。

#layout

• Type: string
• Default: undefined

渲染页面时使用的布局。

#api

• Type: boolean
• Default: false

表示当前页为 api 页面。相当于pageType: 'api'：

---
api: true
---

#hero

• Type: Object

home 页面的 hero 配置。它有以下类型：

export interface Hero {
  name: string;
  text: string;
  tagline: string;
  image?: {
    src: string;
    alt: string;
  };
  actions: {
    text: string;
    link: string;
    theme: 'brand' | 'alt';
  }[];
}

#features

• Type: Array
• Default: []

home 页面的功能配置。它有以下类型：

export interface Feature {
  title: string;
  details: string;
  icon: string;
}

#sidebar

• Type: boolean
• Default: true

是否在页面上显示左侧边栏。设置为 false 可以隐藏它。

#outline

• Type: boolean
• Default: true

是否在页面上显示右侧大纲。设置为 false 可以隐藏它。

#lineNumbers

• Type: boolean
• Default: false

是否在当前页面的代码块中显示行号。

#sponsors

• Type: Sponsor[]
• Default: []

页面的赞助商列表。

export interface Sponsor {
  name: string;
  logo: string;
  link: string;
}

#cta

• Type: Object

号召性用语配置。

export interface CTA {
  title: string;
  text?: string;
  link?: string;
  buttonText?: string;
}