API 参考

欢迎使用 VitePress API 参考文档。这里提供了 VitePress 所有 API 的详细说明。

模块概览

模块	说明
配置参考	站点配置选项完整说明
前端配置	Frontmatter 配置选项
运行时 API	Vue 组件中可用的运行时 API
CLI 命令	命令行工具使用指南
主题 API	主题开发相关 API

快速导航

配置相关

文档	核心内容	使用场景
站点配置	defineConfig 完整选项	配置站点标题、导航、侧边栏
Frontmatter	页面级配置	设置页面标题、描述、布局
主题配置	默认主题选项	自定义主题外观和行为

API 相关

文档	核心内容	使用场景
运行时 API	useData、useRoute 等	Vue 组件中获取站点数据
构建 API	构建相关 API	自定义构建流程
主题 API	主题开发 API	开发自定义主题

工具

文档	核心内容	使用场景
CLI 命令	vitepress 命令详解	启动开发服务器、构建、预览

核心 API 速查

站点配置

import { defineConfig } from 'vitepress'

export default defineConfig({
  title: '我的文档站',
  description: '文档站描述',
  themeConfig: {
    nav: [...],
    sidebar: {...}
  }
})

Frontmatter 配置

---
title: 页面标题
description: 页面描述
layout: doc
---

运行时 API

<script setup>
import { useData, useRoute } from 'vitepress'

const { page, frontmatter, title } = useData()
const route = useRoute()
</script>

CLI 命令

# 启动开发服务器
vitepress dev docs

# 构建生产版本
vitepress build docs

# 预览构建结果
vitepress preview docs

按场景查找

常见配置场景

场景	相关配置	文档链接
设置站点标题	title, titleTemplate	站点配置
添加导航栏	themeConfig.nav	主题配置
配置侧边栏	themeConfig.sidebar	主题配置
添加搜索	themeConfig.search	主题配置
多语言支持	locales	站点配置
自定义主题色	CSS 变量	主题配置

开发场景

场景	相关 API	文档链接
获取页面数据	useData()	运行时 API
获取路由信息	useRoute()	运行时 API
添加自定义组件	enhanceApp	主题 API
自定义构建	buildEnd	构建 API

如何使用本参考

1. 查找配置项：使用左侧导航或搜索功能快速定位
2. 查看类型定义：TypeScript 用户可直接查看类型提示
3. 参考示例：每个配置项都包含使用示例

提示

本参考文档持续更新中，如有遗漏或错误，欢迎提交反馈。

学习路径

1. 入门：先阅读站点配置了解基础配置
2. 进阶：学习运行时 API开发自定义组件
3. 高级：掌握主题 API开发自定义主题