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": "/logo.svg",
  "nav": [
    {
      "text": "指南",
      "link": "/"
    },
    {
      "text": "配置",
      "link": "/markdown-examples"
    },
    {
      "text": "插件",
      "link": "/markdown-examples"
    },
    {
      "text": "相关链接",
      "items": [
        {
          "text": "Vite v3文档",
          "link": "https://v3.vitejs.dev/"
        },
        {
          "text": "Vite v3文档",
          "link": "https://v2.vitejs.dev/"
        }
      ]
    },
    {
      "text": "Version",
      "items": [
        {
          "text": "Vite v3文档",
          "link": "https://v3.vitejs.dev/"
        },
        {
          "text": "Vite v3文档",
          "link": "https://v2.vitejs.dev/"
        }
      ]
    }
  ],
  "search": {
    "provider": "local"
  },
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    },
    {
      "text": "接口",
      "items": [
        {
          "text": "流程接口",
          "link": "/flow_interface/flow_interface.md"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "mastodon",
      "link": "https://github.com/vuejs/vitepress"
    },
    {
      "icon": "twitter",
      "link": "https://github.com/vuejs/vitepress"
    },
    {
      "icon": "discord",
      "link": "https://github.com/vuejs/vitepress"
    },
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式"
}

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.