Runtime API Examples

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:

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

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

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>

Results

Theme Data

{
  "logo": "/logo.png",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "产品介绍",
      "link": "/markdown-examples"
    },
    {
      "text": "个人中心",
      "link": "/api-examples"
    }
  ],
  "sidebar": [
    {
      "text": "个人中心",
      "items": [
        {
          "text": "个人信息",
          "link": "/markdown-examples"
        },
        {
          "text": "我的订单",
          "link": "/api-examples"
        }
      ]
    },
    {
      "text": "产品介绍",
      "items": [
        {
          "text": "Accfox号狐浏览器｜产品介绍",
          "link": "/markdown-examples"
        },
        {
          "text": "客户端下载",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2025-2026 present Evan You"
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.