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": {
    "src": "/images/vb6.pro-logo-32x32.png",
    "width": 24,
    "height": 24
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://gitee.com/woeoio/doc.vb6.pro"
    },
    {
      "icon": "googlehome",
      "link": "http://a-vi.com"
    },
    {
      "icon": "rocketdotchat",
      "link": "https://chat.vb6.pro/"
    },
    {
      "icon": "qq",
      "link": "http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=maQtC3a5Zxb3gMLvwpj6oE5fwmZGCOlY&authKey=8%2FhBgSMLqADLatzXghFXO5BIBa%2BxSoHO%2FHFvtbZQk2kURUx%2FegxZukzAvhSPX6WJ&noverify=0&group_code=915520648"
    }
  ],
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "zh": {
          "translations": {
            "button": {
              "buttonText": "搜索文档",
              "buttonAriaLabel": "搜索文档"
            },
            "modal": {
              "noResultsText": "无法找到相关结果",
              "resetButtonTitle": "清除查询条件",
              "footer": {
                "selectText": "选择",
                "navigateText": "切换"
              }
            }
          }
        },
        "en": {
          "translations": {
            "button": {
              "buttonText": "Search",
              "buttonAriaLabel": "Search"
            },
            "modal": {
              "noResultsText": "No results found",
              "resetButtonTitle": "Clear query conditions",
              "footer": {
                "selectText": "Select",
                "navigateText": "Switch"
              }
            }
          }
        }
      }
    }
  },
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "VBMAN",
      "link": "/vbman/"
    },
    {
      "text": "VBMAN2",
      "link": "/vbman2/"
    },
    {
      "text": "旧版文档",
      "link": "https://doc0.vb6.pro/"
    },
    {
      "text": "博客",
      "link": "https://vb6.pro/"
    }
  ],
  "sidebar": {
    "/vbman/": [
      {
        "text": "VBMAN 文档",
        "items": [
          {
            "text": "介绍",
            "link": "/vbman/"
          },
          {
            "text": "示例",
            "collapsed": false,
            "items": [
              {
                "text": "Hello World",
                "link": "/vbman/demo/1.HelloWorld"
              },
              {
                "text": "Web 根目录",
                "link": "/vbman/demo/2.Webroot"
              },
              {
                "text": "数据库",
                "link": "/vbman/demo/3.Database"
              },
              {
                "text": "JSON",
                "link": "/vbman/demo/4.cJson"
              },
              {
                "text": "中间件",
                "link": "/vbman/demo/5.MiddleWare"
              },
              {
                "text": "SSE",
                "link": "/vbman/demo/6.SSE"
              },
              {
                "text": "SSE2",
                "link": "/vbman/demo/7.SSE2"
              },
              {
                "text": "WebSocket",
                "link": "/vbman/demo/8.WebSocket"
              },
              {
                "text": "API调用",
                "link": "/vbman/demo/9.ApiCall"
              },
              {
                "text": "多进程",
                "link": "/vbman/demo/10.Multiprocessor"
              },
              {
                "text": "网络数据展示",
                "link": "/vbman/demo/11.NetDataShow"
              },
              {
                "text": "后台管理",
                "link": "/vbman/demo/12.AdminEnd"
              }
            ]
          }
        ]
      }
    ],
    "/vbman2/": [
      {
        "text": "VBMAN2 文档",
        "items": [
          {
            "text": "介绍",
            "link": "/vbman2/index"
          },
          {
            "text": "核心功能",
            "link": "/vbman2/core"
          },
          {
            "text": "事件参考",
            "link": "/vbman2/events"
          },
          {
            "text": "设置配置",
            "link": "/vbman2/settings"
          },
          {
            "text": "高级功能",
            "link": "/vbman2/advanced"
          },
          {
            "text": "进程管理",
            "link": "/vbman2/process"
          }
        ]
      }
    ]
  },
  "footer": {
    "message": "基于 VB6组件 发布",
    "copyright": "版权所有 © 2019-2025 邓伟"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "lastUpdated": {
    "text": "最后更新",
    "formatOptions": {
      "dateStyle": "short",
      "timeStyle": "short",
      "timeZone": "Asia/Shanghai"
    }
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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