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": "指南",
      "link": "/guide/basic/getting-start"
    }
  ],
  "sidebar": [
    {
      "text": "基础说明",
      "items": [
        {
          "text": "BROS-GUI 与 BROS",
          "link": "/guide/basic/getting-start"
        },
        {
          "text": "BROS-GUI",
          "link": "/guide/basic/bros-gui"
        },
        {
          "text": "BROS",
          "link": "/guide/basic/bros"
        }
      ]
    },
    {
      "text": "配置说明",
      "items": [
        {
          "text": "执行器",
          "link": "/guide/config/bros-config"
        },
        {
          "text": "通用配置",
          "link": "/guide/config/config"
        },
        {
          "text": "交互后端",
          "link": "/guide/config/backend"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/BrackRat/BROS-GUI"
    }
  ],
  "footer": {
    "copyright": "Copyright © 2024 BrackRat"
  },
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "zh": {
          "translations": {
            "button": {
              "buttonText": "搜索文档",
              "buttonAriaLabel": "搜索文档"
            },
            "modal": {
              "noResultsText": "无法找到相关结果",
              "resetButtonTitle": "清除查询条件",
              "footer": {
                "selectText": "选择",
                "navigateText": "切换"
              }
            }
          }
        }
      }
    }
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  }
}

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.