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": [
    {
      "link": "/",
      "text": "Home"
    },
    {
      "link": "/markdown-examples",
      "text": "Examples"
    }
  ],
  "sidebar": [
    {
      "items": [
        {
          "link": "/components/button",
          "text": "Button 按钮"
        },
        {
          "link": "/components/collapse",
          "text": "Collapse 折叠面板"
        },
        {
          "link": "/markdown-examples",
          "text": "Markdown Examples"
        },
        {
          "link": "/api-examples",
          "text": "Runtime API Examples"
        }
      ],
      "text": "基础组件"
    },
    {
      "items": [
        {
          "link": "/components/alert",
          "text": "Alert 提示"
        }
      ],
      "text": "反馈组件"
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.