API 参考

配置 API

defineConfig

定义 VitePress 站点配置的入口函数。

import { defineConfig } from 'vitepress'

export default defineConfig({
  // 站点配置
})

Frontmatter

每个 Markdown 文件顶部可以添加 YAML 格式的 Frontmatter：

---
title: 页面标题
description: 页面描述
layout: doc          # doc | home | page
sidebar: false       # 是否显示侧边栏
outline: [2, 3]      # 大纲标题层级
---

常用 Frontmatter 字段

字段	类型	说明
title	string	页面标题
description	string	页面描述
layout	string	布局模式：doc / home / page
sidebar	boolean	是否显示侧边栏
outline	number | [number, number]	大纲层级范围

主题配置

nav

顶部导航栏配置。

nav: [
  { text: '首页', link: '/' },
  { text: '指南', link: '/guide/getting-started' }
]

sidebar

侧边栏配置，支持按路径分组。

search

搜索配置，支持本地搜索和 Algolia 搜索。

search: {
  provider: 'local'    // 或 'algolia'
}