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": "猫影",
  "logo": "https://maovideo.oss-cn-guangzhou.aliyuncs.com/logo.svg",
  "outDir": "docs",
  "lastUpdated": true,
  "sidebarMenuLabel": "目录",
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/gzyxds/maovideo"
    }
  ],
  "editLink": {
    "pattern": "https://github.com/gzyxds/maovideo",
    "text": "编辑本页"
  },
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "APP下载",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "footer": {
    "message": "Released under the MaoVideo Public License.",
    "copyright": "Copyright © 2024-MAOVIDEO All Rights Reserved"
  },
  "prev": "上一篇",
  "returnToTopLabel": "返回顶部",
  "outline": "目录"
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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