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": "/tutorials/mineru-windows-install.md"
    },
    {
      "text": "BLE",
      "link": "/ble/ananlyzer.md"
    }
  ],
  "sidebar": [
    {
      "text": "教程",
      "items": [
        {
          "text": "Windows 上安装、运行与测试 MinerU",
          "link": "/tutorials/mineru-windows-install.md"
        }
      ]
    },
    {
      "text": "Examples",
      "items": [
        {
          "text": "BLE Stack 工程深度分析",
          "link": "/ble/ananlyzer.md"
        },
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        },
        {
          "text": "undefined reference to lwip_inet_ntop/lwip_inet_pton",
          "link": "/ble/lwip_inet_ntop.md"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/Aron-Tech-a"
    }
  ]
}

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.