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": "/privacy-guidelines"
    }
  ],
  "sidebar": [
    {
      "text": "文档中心",
      "items": [
        {
          "text": "隐私保护指引",
          "link": "/privacy-guidelines"
        },
        {
          "text": "个人信息保护规则",
          "link": "/personal-information-protection-policy"
        },
        {
          "text": "用户协议",
          "link": "/user-agreement"
        },
        {
          "text": "软件许可及服务协议",
          "link": "/software-license-and-service-agreement"
        },
        {
          "text": "隐私政策",
          "link": "/privacy-policy"
        },
        {
          "text": "服务协议",
          "link": "/terms-of-service"
        },
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ]
}

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.