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",
  "siteTitle": "博客记录",
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    },
    {
      "text": "前端",
      "items": []
    },
    {
      "text": "后端",
      "items": []
    },
    {
      "text": "Linux",
      "items": []
    },
    {
      "text": "第N次入门Rust",
      "items": []
    },
    {
      "text": "育儿知识",
      "link": "/parenting/如何冲奶粉"
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    },
    {
      "text": "育儿知识",
      "items": [
        {
          "text": "如何冲奶粉",
          "link": "/parenting/如何冲奶粉"
        },
        {
          "text": "如何喂奶",
          "link": "/parenting/如何喂奶"
        },
        {
          "text": "如何拍嗝",
          "link": "/parenting/如何拍嗝"
        },
        {
          "text": "如何缓解宝宝肠胀气",
          "link": "/parenting/如何缓解宝宝肠胀气"
        },
        {
          "text": "吐奶、溢奶、呛奶",
          "link": "/parenting/吐奶、溢奶、呛奶"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/caigq99"
    }
  ]
}

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.