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": "/docs/installation"
    },
    {
      "text": "联系我们",
      "link": "/contact"
    }
  ],
  "sidebar": {
    "/": [
      {
        "text": "快速入门",
        "collapsed": false,
        "items": [
          {
            "text": "快速入门 1：类视搜图软件安装",
            "link": "/docs/installation"
          },
          {
            "text": "快速入门 2：首次启动与初始化",
            "link": "/docs/first_init"
          },
          {
            "text": "快速入门 3：图库管理界面",
            "link": "/docs/gallery-management"
          },
          {
            "text": "快速入门 4：浏览图片",
            "link": "/docs/browsing-images"
          },
          {
            "text": "快速入门 5：本地以图搜图",
            "link": "/docs/local-image-search"
          },
          {
            "text": "快速入门 6：企业搜图",
            "link": "/docs/enterprise-search"
          },
          {
            "text": "快速入门 7：语义描述搜图",
            "link": "/docs/semantic-search"
          },
          {
            "text": "快速入门 8：以文搜图",
            "link": "/docs/text-search"
          }
        ]
      },
      {
        "text": "帮助与支持",
        "collapsed": false,
        "items": [
          {
            "text": "常见问题",
            "link": "/docs/faq"
          }
        ]
      },
      {
        "text": "协议声明",
        "collapsed": true,
        "items": [
          {
            "text": "用户协议",
            "link": "/licence"
          },
          {
            "text": "隐私政策",
            "link": "/declare"
          }
        ]
      }
    ]
  },
  "outlineTitle": "本页目录",
  "lastUpdatedText": "最后更新时间",
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "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.