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": "主页",
      "link": "/"
    },
    {
      "text": "介绍页",
      "link": "/jieshao"
    }
  ],
  "sidebar": [
    {
      "text": "文章目录",
      "items": [
        {
          "text": "介绍",
          "link": "/jieshao"
        },
        {
          "text": "magisk模块介绍",
          "link": "/magisk"
        },
        {
          "text": "LSPosed模块介绍",
          "link": "/LSPosed"
        },
        {
          "text": "实用软件介绍",
          "link": "/app"
        },
        {
          "text": "第三方内核介绍",
          "link": "/Kernel"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/wobushilixi"
    }
  ]
}

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.