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": "Home",
      "link": "/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "基本",
      "items": [
        {
          "text": "简介",
          "link": "/intro"
        }
      ]
    },
    {
      "text": "内容",
      "items": [
        {
          "text": "零门槛入门：AI副业月入5000+的3个真实路径",
          "link": "/content/3-paths"
        },
        {
          "text": "深度拆解：72小时打造AI短视频账号，单条作品变现800+的全流程解剖",
          "link": "/content/ai-short-video"
        },
        {
          "text": "硬核图解：1500元搭建AI数字人直播间，破解同城流量密码",
          "link": "/content/digital-human-live"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.