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": "/01_官方示例文件/markdown-examples"
    },
    {
      "text": "其他",
      "link": "/02_自己加的文件/01_测试图片"
    }
  ],
  "sidebar": [
    {
      "text": "官方示例文件",
      "items": [
        {
          "text": "api-examples",
          "link": "/01_官方示例文件/api-examples"
        },
        {
          "text": "markdown-examples",
          "link": "/01_官方示例文件/markdown-examples"
        }
      ],
      "collapsed": false
    },
    {
      "text": "自己加的文件",
      "items": [
        {
          "text": "测试图片",
          "link": "/02_自己加的文件/01_测试图片"
        }
      ],
      "collapsed": false
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "01_官方示例文件/api-examples.md",
  "filePath": "01_官方示例文件/api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.