VitePress 中文网运行时API
VitePress 提供了多个内置 API 来让您访问应用程序数据。 VitePress 还附带了一些可以在全球范围内使用的内置组件。
辅助方法可从vitepress全局导入，通常用于自定义主题 Vue 组件。然而，它们也可以在 .md 页面中使用，因为 markdown 文件被编译到 Vue 单文件组件 中。
以 use* 开头的方法表示它是一个只能在内部使用的 Vue 3 Composition API 函数（"实验性"） setup() 或 <script setup>。
useData 实验性
返回特定于页面的数据。返回的对象具有以下类型：
ts
interface VitePressData<T = any> {
/**
* Site-level metadata
*/
site: Ref<SiteData<T>>
/**
* themeConfig from .vitepress/config.js
*/
theme: Ref<T>
/**
* Page-level metadata
*/
page: Ref<PageData>
/**
* Page frontmatter
*/
frontmatter: Ref<PageData['frontmatter']>
/**
* Dynamic route params
*/
params: Ref<PageData['params']>
title: Ref<string>
description: Ref<string>
lang: Ref<string>
isDark: Ref<boolean>
dir: Ref<string>
localeIndex: Ref<string>
}
interface PageData {
title: string
titleTemplate?: string | boolean
description: string
relativePath: string
filePath: string,
headers: Header[]
frontmatter: Record<string, any>
params?: Record<string, any>
isNotFound?: boolean
lastUpdated?: number
}示例:
vue
<script setup>
import { useData } from 'vitepress'
const { theme } = useData()
</script>
<template>
<h1>{{ theme.footer.copyright }}</h1>
</template>useRoute 实验性
返回当前路由对象，其类型如下：
ts
interface Route {
path: string
data: PageData
component: Component | null
}useRouter 实验性
返回 VitePress 路由器实例，以便您可以以编程方式导航到另一个页面。
ts
interface Router {
/**
* Current route.
*/
route: Route
/**
* Navigate to a new URL.
*/
go: (to?: string) => Promise<void>
/**
* Called before the route changes. Return `false` to cancel the navigation.
*/
onBeforeRouteChange?: (to: string) => Awaitable<void | boolean>
/**
* Called before the page component is loaded (after the history state is
* updated). Return `false` to cancel the navigation.
*/
onBeforePageLoad?: (to: string) => Awaitable<void | boolean>
/**
* Called after the route changes.
*/
onAfterRouteChanged?: (to: string) => Awaitable<void>
}withBase helper
- 类型:
(path: string) => string
将配置的 base 附加到给定的 URL 路径。另请参阅基本 URL。
<Content /> 组件
<Content /> 组件显示渲染的 Markdown 内容。 创建自己的主题时 很有用。
vue
<template>
<h1>Custom Layout!</h1>
<Content />
</template><ClientOnly /> 组件
<ClientOnly /> 组件仅在客户端呈现其插槽。
由于 VitePress 应用程序在生成静态构建时是在 Node.js 中进行服务器渲染的，因此任何 Vue 使用都必须符合通用代码要求。简而言之，确保仅在 beforeMount 或 Mounted 挂钩中访问浏览器/DOM API。
如果您正在使用或演示不适合 SSR 的组件（例如，包含自定义指令），您可以将它们包装在 ClientOnly 组件中。
template
<ClientOnly>
<NonSSRFriendlyComponent />
</ClientOnly>$frontmatter 全局模板
在Vue表达式中直接访问当前页面的frontmatter数据。
md
---
title: Hello
---
# {{ $frontmatter.title }}$params 全局模板
在Vue表达式中直接访问当前页面的动态路由参数。
md
- package name: {{ $params.pkg }}
- version: {{ $params.version }}