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

{
  "footer": {
    "message": "基于 MIT 许可发布",
    "copyright": "版权所有 © 2010-至今 upidea.com"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "outline": {
    "label": "页面导航"
  },
  "lastUpdated": {
    "text": "最后更新于"
  },
  "langMenuLabel": "多语言",
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "skipToContentLabel": "跳转到内容",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "下  载",
      "link": "/changelog"
    },
    {
      "text": "开发笔记",
      "link": "/development"
    }
  ],
  "sidebar": [
    {
      "text": "版本历史",
      "link": "/changelog"
    },
    {
      "text": "开发笔记",
      "items": [
        {
          "text": "开发随手纪要",
          "link": "/development"
        },
        {
          "text": "Tiled地图解析思路",
          "link": "/development/Tiled地图解析思路"
        },
        {
          "text": "转成网页游戏的过程",
          "link": "/development/WebAssembly_Porting_Tutorial"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/upidea/catchTheCat"
    }
  ]
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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