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

{
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "前端开发",
      "link": "/fe/css",
      "activeMatch": "/fe/"
    },
    {
      "text": "Java开发",
      "link": "/java/hutool",
      "activeMatch": "/java/"
    },
    {
      "text": "数据库",
      "link": "/db/mysql",
      "activeMatch": "/db/"
    },
    {
      "text": "项目部署",
      "link": "/om/linux",
      "activeMatch": "/om/"
    }
  ],
  "sidebar": {
    "/fe/": [
      {
        "items": [
          {
            "text": "css",
            "link": "/fe/css"
          },
          {
            "text": "js",
            "link": "/fe/js"
          },
          {
            "text": "cdn",
            "link": "/fe/cdn"
          }
        ]
      }
    ],
    "/java/": [
      {
        "items": [
          {
            "text": "hutool工具类",
            "link": "/java/hutool"
          }
        ]
      }
    ],
    "/db/": [
      {
        "items": [
          {
            "text": "mysql",
            "link": "/db/mysql"
          },
          {
            "text": "redis",
            "link": "/db/redis"
          }
        ]
      }
    ],
    "/om/": [
      {
        "items": [
          {
            "text": "linux常用命令",
            "link": "/om/linux"
          }
        ]
      }
    ]
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "outline": {
    "label": "页面导航"
  },
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "socialLinks": []
}

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.