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": "Home",
      "link": "/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    },
    {
      "text": "指南",
      "link": "/guide/",
      "activeMatch": "/guide/"
    }
  ],
  "sidebar": {
    "/": {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    },
    "/guide/": {
      "items": [
        {
          "text": "指南",
          "items": [
            {
              "text": "测试页面",
              "link": "/guide/测试"
            },
            {
              "text": "测试页面2",
              "link": "/guide/测试2"
            }
          ],
          "collapsed": false
        },
        {
          "text": "写作",
          "items": [
            {
              "text": "测试页面3",
              "link": "/guide/测试3"
            },
            {
              "text": "测试页面4",
              "link": "/guide/测试4"
            }
          ],
          "collapsed": true
        }
      ]
    }
  },
  "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.