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.png",
  "nav": [
    {
      "text": "主页",
      "link": "/"
    },
    {
      "text": "StarPay旧版文档",
      "link": "/person"
    },
    {
      "text": "StarPay新版文档",
      "link": "/merchant"
    },
    {
      "text": "授权中心",
      "link": "https://shop.xccyidc.xyz",
      "target": "_blank"
    }
  ],
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "outline": {
    "label": "目录",
    "level": [
      2,
      3
    ]
  },
  "sidebar": [
    {
      "text": "StarPay旧版文档",
      "items": [
        {
          "text": "快速开始",
          "link": "/old"
        },
        {
          "text": "安装",
          "items": [
            {
              "text": "环境要求",
              "link": "/old/install/env"
            },
            {
              "text": "下载安装包",
              "link": "/old/install/download"
            }
          ]
        }
      ]
    }
  ],
  "footer": {
    "message": "高性能,安全,快速 就选StarPay.",
    "copyright": "Copyright © 2024-present Mr.Faith<br/><a href='https://beian.miit.gov.cn/'>渝ICP备2025050645号-1</a>"
  }
}

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.