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": "主页",
      "link": "/"
    },
    {
      "text": "笔记",
      "link": "/iOS/Swift 内存"
    }
  ],
  "sidebar": [
    {
      "text": "iOS",
      "items": [
        {
          "text": "Swift 内存",
          "link": "/iOS/Swift 内存"
        }
      ]
    },
    {
      "text": "Android",
      "items": []
    },
    {
      "text": "React Native",
      "items": []
    },
    {
      "text": "Flutter",
      "items": []
    },
    {
      "text": "AI",
      "items": [
        {
          "text": "Claude Skill 优化",
          "link": "/AI/Claude Skill 优化"
        },
        {
          "text": "AI 结构化输出",
          "link": "/AI/AI 结构化输出"
        }
      ]
    }
  ],
  "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.