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": "Vue 笔记",
      "link": "/posts/vue-notes"
    },
    {
      "text": "React 探索",
      "link": "/posts/react-learning"
    },
    {
      "text": "面试题",
      "link": "/posts/mian"
    },
    {
      "text": "关于我",
      "link": "/about"
    }
  ],
  "sidebar": [
    {
      "text": "技术文章",
      "items": [
        {
          "text": "Vue 3 踩坑记录",
          "link": "/posts/vue-notes"
        },
        {
          "text": "React Hooks 初体验",
          "link": "/posts/react-learning"
        }
      ]
    },
    {
      "text": "八股",
      "items": [
        {
          "text": "面试题",
          "link": "/posts/mian"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/hefezada98-sudo"
    }
  ]
}

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.