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": "/"
    }
  ],
  "sidebar": [
    {
      "text": "开始",
      "items": [
        {
          "text": "引导页",
          "link": "/docs"
        }
      ]
    },
    {
      "text": "教程",
      "items": [
        {
          "text": "手机安装VitePress",
          "link": "/手机安装VitePress"
        },
        {
          "text": "手机安装Ubuntu",
          "link": "/手机安装Ubuntu或Debian"
        }
      ]
    },
    {
      "text": "何意味",
      "items": [
        {
          "text": "奶龙唐笑",
          "link": "/奶龙唐笑"
        }
      ]
    },
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "bilibili",
      "link": "https://m.bilibili.com/space/3546744979720373"
    }
  ]
}

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.