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

{
  "siteTitle": "一串烤肉",
  "nav": [
    {
      "text": "MySQL",
      "link": "/mysql/"
    },
    {
      "text": "vitepress学习",
      "link": "/vitepressnote/"
    },
    {
      "text": "宝藏网站",
      "link": "/treasure/"
    },
    {
      "text": "ai",
      "link": "/ai/"
    },
    {
      "text": "clickhouse",
      "link": "/clickhouse/"
    },
    {
      "text": "mybatis",
      "link": "/mybatis/"
    },
    {
      "text": "maven",
      "link": "/maven/"
    }
  ],
  "sidebar": [
    {
      "text": "MySQL",
      "items": [
        {
          "text": "介绍",
          "link": "/mysql"
        },
        {
          "text": "本机安装",
          "link": "./install"
        }
      ]
    },
    {
      "text": "clickhouse",
      "items": [
        {
          "text": "介绍",
          "link": "/mysql"
        },
        {
          "text": "本机安装",
          "link": "./install"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2019-present Evan You"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "outline": {
    "label": "页面导航",
    "level": "deep"
  },
  "lastUpdated": {
    "text": "最后更新于",
    "formatOptions": {
      "dateStyle": "short",
      "timeStyle": "medium"
    }
  },
  "langMenuLabel": "多语言",
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "darkModeSwitchLabel": "主题",
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式"
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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