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": "/talk"
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    },
    {
      "text": "React",
      "items": []
    },
    {
      "text": "状态管理",
      "items": []
    },
    {
      "text": "路由方案",
      "items": []
    },
    {
      "text": "请求方案",
      "items": []
    },
    {
      "text": "样式方案",
      "items": []
    },
    {
      "text": "组件库",
      "items": []
    },
    {
      "text": "Hooks库",
      "items": []
    },
    {
      "text": "构建工具",
      "items": []
    },
    {
      "text": "编译原理",
      "items": []
    },
    {
      "text": "服务端开发",
      "items": []
    },
    {
      "text": "跨端开发",
      "items": []
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/iolh/iolh.github.io/"
    }
  ]
}

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.