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

插件名

插件ID

插件版本

插件描述

平台

android iOS

平台配置

android

minSdkVersion

hooksClass

abis

armeabi-v7aarm64-v8ax86

android插件

android依赖

android参数

{
  "name": "",
  "id": "",
  "version": "1.0.0",
  "description": "",
  "_dp_type": "nativeplugin",
  "_dp_nativeplugin": {
    "android": {
      "integrateType": "aar",
      "minSdkVersion": 21,
      "compileOptions": {
        "sourceCompatibility": "1.8",
        "targetCompatibility": "1.8"
      }
    }
  }
}

Theme Data

{
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    },
    {
      "text": "工具",
      "items": [
        {
          "text": "uni-app插件package.json生成",
          "link": "/tools/uni-plugin-pkg"
        },
        {
          "text": "uni-app(x)离线打包工具辅助",
          "link": "/tools/uni-pkg-cli"
        }
      ]
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        },
        {
          "text": "我的工具",
          "items": [
            {
              "text": "uni-app插件package.json生成",
              "link": "/tools/uni-plugin-pkg"
            },
            {
              "text": "uni-app(x)离线打包工具辅助",
              "link": "/tools/uni-pkg-cli"
            }
          ]
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.