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

{
  "logo": "/logo.svg",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "文档",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "文档",
      "items": [
        {
          "text": "使用文档",
          "link": "/markdown-examples"
        },
        {
          "text": "常见问题",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "sitemap": {
    "hostname": "https://docs.sequoiamc.cn"
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/SequoiaMC-CN/Docs"
    }
  ],
  "outline": {
    "level": [
      2,
      4
    ],
    "label": "总览"
  },
  "editLink": {
    "pattern": "https://github.com/SequoiaMC-CN/Docs/edit/main/docs/:path",
    "text": "在GitHub编辑本页"
  },
  "lastUpdated": {
    "text": "最后更新于",
    "formatOptions": {
      "dateStyle": "short",
      "timeStyle": "medium"
    }
  },
  "darkModeSwitchLabel": "深浅模式",
  "docFooter": {
    "prev": "上一篇",
    "next": "下一篇"
  },
  "outlineTitle": "页面内容",
  "returnToTopLabel": "返回顶部",
  "sidebarMenuLabel": "菜单",
  "search": {
    "provider": "local"
  },
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2025-2026 SequoiaMC-CN | ICP备案号：<a href=\"https://beian.miit.gov.cn/\" target=\"_blank\">豫ICP备2025139441号-2</a>"
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md",
  "lastUpdated": 1765256520000
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.