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": "https://registry.npmmirror.com/@ao-x/assets/latest/files/ac.cn/live/logo.avif",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "文档",
      "link": "/document"
    },
    {
      "text": "反馈问题",
      "link": "https://txc.qq.com/products/366003"
    }
  ],
  "sidebar": [
    {
      "text": "目录",
      "link": "/document"
    },
    {
      "text": "哔哩哔哩",
      "collapsed": true,
      "items": [
        {
          "text": "简介",
          "link": "/bilibili/README"
        },
        {
          "text": "开播要求与准备",
          "link": "/bilibili/yaoqiuyuzhunbei"
        },
        {
          "text": "开播流程",
          "link": "/bilibili/liucheng"
        }
      ]
    }
  ],
  "langMenuLabel": "多语言",
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "darkModeSwitchLabel": "主题",
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式",
  "outline": {
    "label": "页面导航"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "search": {
    "provider": "algolia",
    "options": {
      "appId": "...",
      "apiKey": "...",
      "indexName": "...",
      "placeholder": "搜索文档",
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "searchBox": {
            "resetButtonTitle": "清除查询条件",
            "resetButtonAriaLabel": "清除查询条件",
            "cancelButtonText": "取消",
            "cancelButtonAriaLabel": "取消"
          },
          "startScreen": {
            "recentSearchesTitle": "搜索历史",
            "noRecentSearchesText": "没有搜索历史",
            "saveRecentSearchButtonTitle": "保存至搜索历史",
            "removeRecentSearchButtonTitle": "从搜索历史中移除",
            "favoriteSearchesTitle": "收藏",
            "removeFavoriteSearchButtonTitle": "从收藏中移除"
          },
          "errorScreen": {
            "titleText": "无法获取结果",
            "helpText": "你可能需要检查你的网络连接"
          },
          "footer": {
            "selectText": "选择",
            "navigateText": "切换",
            "closeText": "关闭",
            "searchByText": "搜索提供者"
          },
          "noResultsScreen": {
            "noResultsText": "无法找到相关结果",
            "suggestedQueryText": "你可以尝试查询",
            "reportMissingResultsText": "你认为该查询应该有结果？",
            "reportMissingResultsLinkText": "点击反馈"
          }
        }
      }
    }
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "bilibili/yaoqiuyuzhunbei.md",
  "filePath": "bilibili/yaoqiuyuzhunbei.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

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