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": "img/favicon.ico",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "文档",
      "link": "/markdown-examples"
    },
    {
      "text": "微信公众号",
      "link": "/weixin"
    }
  ],
  "search": {
    "provider": "local"
  },
  "sidebar": [
    {
      "text": "简介",
      "items": [
        {
          "text": "关于 OPEN WinGO",
          "link": "/about"
        },
        {
          "text": "微信公众号",
          "link": "/weixin"
        }
      ]
    }
  ],
  "footer": {
    "message": "<a href=\"https://beian.miit.gov.cn/\" target=\"_blank\" rel=\"noreferrer\">陕ICP备2023007133号-2</a><br><a href=\"#\" target=\"_blank\" rel=\"noreferrer\">川公网安备51011502000812号</a>",
    "copyright": "COPYRIGHT © 2024-2024 Cooa-OPEN WinGO"
  }
}

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.