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

{
  "siteTitle": "Geekmister",
  "logo": "/logo.png",
  "nav": [
    {
      "text": "创业项目",
      "link": "/api-examples"
    },
    {
      "text": "心理研究",
      "link": "/api-examples"
    },
    {
      "text": "信息技术",
      "items": [
        {
          "text": "前端开发",
          "link": "/zh-CN/front-end"
        },
        {
          "text": "后端开发",
          "link": "/zh-CN/back-end"
        }
      ]
    },
    {
      "text": "小册子",
      "link": "/api-examples"
    },
    {
      "text": "书",
      "link": "/markdown-examples"
    },
    {
      "text": "关于",
      "link": "/zh-CN/ops"
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/geekmister"
    },
    {
      "icon": "x",
      "link": "https://github.com/geekmister"
    }
  ]
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "zh/api-examples.md",
  "filePath": "zh/api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

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