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": "/about"
    },
    {
      "text": "联系我们",
      "link": "/contact"
    },
    {
      "text": "隐私政策",
      "link": "/privacy"
    },
    {
      "text": "服务条款",
      "link": "/terms"
    }
  ],
  "sidebar": [],
  "socialLinks": [],
  "footer": {
    "copyright": "© 2015-2026 思源科技",
    "message": "\n        <a href=\"https://beian.miit.gov.cn/\" target=\"_blank\" rel=\"noopener noreferrer\">\n          浙ICP备15039755号\n        </a>\n      "
  }
}

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.