运行时API示例

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": "Home",
      "link": "/"
    },
    {
      "text": "默认",
      "link": "/default/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/default/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/default/api-examples"
        }
      ]
    }
  ],
  "siteTitle": "极客AI",
  "lastUpdated": {
    "text": "更新时间",
    "formatOptions": {
      "dateStyle": "medium",
      "timeStyle": "short"
    }
  },
  "footer": {
    "message": "<a href=\"https://beian.miit.gov.cn/#/Integrated/index\" style=\"text-decoration:none;\" target=\"_blank\">京ICP备2025114610号-1</a>",
    "copyright": "Copyright © 2025-present Chaos Ma"
  },
  "docFooter": {
    "prev": "上一篇",
    "next": "下一篇"
  },
  "sidebarMenuLabel": "菜单",
  "returnToTopLabel": "返回顶部",
  "darkModeSwitchLabel": "外观",
  "darkModeSwitchTitle": "切换到深色主题",
  "lightModeSwitchTitle": "切换到浅色主题",
  "outline": {
    "level": "deep",
    "label": "页面导航"
  },
  "search": {
    "provider": "local",
    "options": {
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "noResultsText": "无法找到相关结果",
          "resetButtonTitle": "清除查询条件",
          "footer": {
            "selectText": "切换",
            "navigateText": "切换",
            "closeText": "关闭"
          }
        }
      }
    }
  }
}

Page Data

{
  "title": "运行时API示例",
  "titleTemplate": "极客AI",
  "description": "",
  "frontmatter": {
    "titleTemplate": "极客AI",
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "default/api-examples.md",
  "filePath": "default/api-examples.md",
  "lastUpdated": 1741699826000
}

Page Frontmatter

{
  "titleTemplate": "极客AI",
  "outline": "deep"
}

More

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