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

{
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "指南",
      "link": "/guide/"
    },
    {
      "text": "示例",
      "link": "/examples/markdown"
    }
  ],
  "sidebar": [
    {
      "text": "指南",
      "items": [
        {
          "text": "快速开始",
          "link": "/guide/"
        }
      ]
    },
    {
      "text": "Frida 逆向",
      "items": [
        {
          "text": "调用 Kotlin Companion 方法",
          "link": "/frida/kotlin-companion"
        },
        {
          "text": "动态 ClassLoader 查找",
          "link": "/frida/class-loader"
        }
      ]
    },
    {
      "text": "示例",
      "items": [
        {
          "text": "Markdown 示例",
          "link": "/examples/markdown"
        },
        {
          "text": "运行时 API 示例",
          "link": "/examples/api"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "search": {
    "provider": "local"
  },
  "footer": {
    "message": "Released under the MIT License. <a href=\"https://beian.miit.gov.cn/\" target=\"_blank\">冀ICP备18021899号-49</a>",
    "copyright": "Copyright © 2018-2026 亮仔"
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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