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": "/picture/img/brand/icon.ico",
  "siteTitle": "类视搜图",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "软件下载",
      "link": "/download"
    },
    {
      "text": "价格",
      "link": "/pricing"
    },
    {
      "text": "教程",
      "link": "/docs/installation"
    },
    {
      "text": "博客",
      "link": "/blog/"
    },
    {
      "text": "联系我们",
      "link": "/contact"
    },
    {
      "text": "反馈",
      "link": "/feedback"
    }
  ],
  "outline": {
    "level": [
      2,
      3
    ],
    "label": "本页目录"
  },
  "outlineTitle": "本页目录",
  "lastUpdatedText": "最后更新时间",
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "darkModeSwitchLabel": "主题",
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式"
}

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.