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"
    }
  ],
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "root": {
          "translations": {
            "button": {
              "buttonText": "搜索",
              "buttonAriaLabel": "搜索"
            },
            "modal": {
              "noResultsText": "没有找到相关结果"
            }
          }
        }
      }
    }
  },
  "sidebar": [
    {
      "text": "简介",
      "collapsed": false,
      "items": [
        {
          "text": "快速开始",
          "link": "/简介/快速开始"
        }
      ]
    },
    {
      "text": "Java 文档",
      "collapsed": false,
      "items": [
        {
          "text": "Java 公共代码抽象",
          "link": "/Java 文档/Java 公共代码抽象"
        }
      ]
    },
    {
      "text": "扩展",
      "collapsed": false,
      "items": [
        {
          "text": "扩展文档",
          "link": "/扩展/扩展文档"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "footer": {
    "copyright": "Copyright © 2026 YeYuan"
  }
}

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.