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",
  "siteTitle": "诚知付",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "关于我们",
      "link": "/about"
    }
  ],
  "footer": {
    "message": "隐私协议 | 联系我们 | 关于我们",
    "copyright": "Copyright © 2025-2026 成都汇易付科技有限公司 版权所有 | <a href=\"https://beian.miit.gov.cn/\" target=\"_blank\">蜀ICP备2024084319号</a>"
  }
}

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.