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": "活动邀请 / Invitation",
      "link": "/invitation/invitation.md"
    },
    {
      "text": "活动总结 / Summary",
      "link": "/summary/summary.md"
    },
    {
      "text": "关于项目 / About",
      "link": "/introduce.md"
    }
  ],
  "outline": {
    "level": [
      1,
      6
    ],
    "label": "本页目录"
  },
  "sidebar": {
    "/invitation/": [
      {
        "text": "活动邀请",
        "items": [
          {
            "text": "第一期",
            "link": "/invitation/episode-01.md"
          },
          {
            "text": "第二期",
            "link": "/invitation/episode-02.md"
          }
        ]
      }
    ],
    "/summary/": [
      {
        "text": "活动总结",
        "items": [
          {
            "text": "第一期",
            "link": "/summary/episode-01.md"
          },
          {
            "text": "第二期",
            "link": "/summary/episode-02.md"
          }
        ]
      }
    ]
  },
  "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.