api 示例

简介

此页面演示了 VitePress 提供的一些运行时 API 的使用方法。

主 useData() API 可用于访问当前页面的网站、主题和页面数据。它在 .md 和 .vue 文件中都有效：

用法说明

用法如下示例：

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

const { theme, page, frontmatter } = useData()
</script>

## 结果展示

### 主题数据
<pre>{{ theme.nav }}</pre>

### 页面数据
<pre>{{ page }}</pre>

### 页面格式
<pre>{{ frontmatter }}</pre>

结果展示

主题数据

[
  {
    "text": "唯知首页",
    "link": "/"
  },
  {
    "text": "VitePress",
    "items": [
      {
        "text": "基础设置",
        "items": [
          {
            "text": "api 示例",
            "link": "vitepress/basic/api-examples.md"
          }
        ]
      },
      {
        "text": "扩展用法",
        "items": [
          {
            "text": "markdown 示例",
            "link": "/vitepress/extend/markdown-examples.md"
          }
        ]
      }
    ]
  }
]

页面数据

{
  "title": "api 示例",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "vitepress/basic/api-examples.md",
  "filePath": "vitepress/basic/api-examples.md",
  "lastUpdated": 1731145025000
}

页面格式

{
  "outline": "deep"
}

更多

请查看官方文档 VitePress 运行时 API。