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": "入门",
      "items": [
        {
          "text": "简介",
          "link": "/guide/intro"
        },
        {
          "text": "基础教程",
          "link": "/guide/base"
        },
        {
          "text": "通信模型",
          "link": "/guide/communication"
        },
        {
          "text": "使用Docker",
          "link": "/guide/docker"
        }
      ]
    },
    {
      "text": "API",
      "items": [
        {
          "text": "公共",
          "link": "/api/common"
        },
        {
          "text": "好友",
          "link": "/api/friend"
        },
        {
          "text": "群",
          "link": "/api/group"
        },
        {
          "text": "频道",
          "link": "/api/guild"
        }
      ]
    },
    {
      "text": "参考",
      "items": [
        {
          "text": "Patch",
          "link": "/reference/patch"
        }
      ]
    },
    {
      "text": "关于",
      "link": "/about"
    },
    {
      "text": "示例",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": {
    "guide": [
      {
        "text": "开始",
        "items": [
          {
            "text": "简介",
            "link": "/guide/intro"
          },
          {
            "text": "基础教程",
            "link": "/guide/base"
          },
          {
            "text": "通信模型",
            "link": "/guide/communication"
          },
          {
            "text": "使用Docker",
            "link": "/guide/docker"
          }
        ]
      }
    ],
    "api": [
      {
        "text": "API",
        "items": [
          {
            "text": "公共API",
            "link": "/api/common"
          },
          {
            "text": "好友API",
            "link": "/api/friend"
          },
          {
            "text": "群组API",
            "link": "/api/group"
          },
          {
            "text": "频道API",
            "link": "/api/guild"
          }
        ]
      }
    ],
    "config": [
      {
        "text": "Examples2",
        "items": [
          {
            "text": "Markdown Examples",
            "link": "/markdown-examples"
          },
          {
            "text": "Runtime API Examples",
            "link": "/api-examples"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/project-yukihana"
    }
  ]
}

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.