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

{
  "siteTitle": "wangtao's space",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "文章",
      "link": "/markdown-examples"
    },
    {
      "text": "关于",
      "link": "/about"
    },
    {
      "text": "写作指南",
      "link": "/writing-guide"
    }
  ],
  "sidebar": [
    {
      "text": "文章列表",
      "items": [
        {
          "text": "Markdown 示例",
          "link": "/markdown-examples"
        },
        {
          "text": "API 示例",
          "link": "/api-examples"
        },
        {
          "text": "写作指南",
          "link": "/writing-guide"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "footer": {
    "message": "用心记录，用爱分享",
    "copyright": "Copyright © 2025 wangtao"
  },
  "search": {
    "provider": "local"
  },
  "editLink": {
    "pattern": "https://github.com/your-username/your-repo/edit/main/:path",
    "text": "在 GitHub 上编辑此页"
  }
}

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.