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": "Projects",
      "items": [
        {
          "text": "All Projects",
          "link": "/projects/"
        },
        {
          "text": "onebot-kotlin-lib",
          "link": "/projects/onebot-kotlin-lib/"
        },
        {
          "text": "onebot-kotlin-lib-v11",
          "link": "/projects/onebot-kotlin-lib-v11/"
        },
        {
          "text": "onebot-kotlin-lib-v12",
          "link": "/projects/onebot-kotlin-lib-v12/"
        },
        {
          "text": "onebot-kotlin-lib-v11 KDoc",
          "link": "/projects/onebot-kotlin-lib-v11/kotlin-doc"
        },
        {
          "text": "onebot-kotlin-lib-v12 KDoc",
          "link": "/projects/onebot-kotlin-lib-v12/kotlin-doc"
        }
      ]
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": {
    "/projects/onebot-kotlin-lib/": [
      {
        "text": "onebot-kotlin-lib",
        "items": [
          {
            "text": "文档总览",
            "link": "/projects/onebot-kotlin-lib/"
          },
          {
            "text": "模块与依赖",
            "link": "/projects/onebot-kotlin-lib/module-reference"
          },
          {
            "text": "OneBot V11 项目",
            "link": "/projects/onebot-kotlin-lib-v11/"
          },
          {
            "text": "OneBot V12 项目",
            "link": "/projects/onebot-kotlin-lib-v12/"
          }
        ]
      }
    ],
    "/projects/onebot-kotlin-lib-v11/": [
      {
        "text": "onebot-kotlin-lib-v11",
        "items": [
          {
            "text": "V11 总览",
            "link": "/projects/onebot-kotlin-lib-v11/"
          },
          {
            "text": "V11 最小 API",
            "link": "/projects/onebot-kotlin-lib-v11/minimal-api"
          },
          {
            "text": "V11 事件监听",
            "link": "/projects/onebot-kotlin-lib-v11/event-listening"
          },
          {
            "text": "V11 通信模式",
            "link": "/projects/onebot-kotlin-lib-v11/transport-modes"
          },
          {
            "text": "V11 完整 API",
            "link": "/projects/onebot-kotlin-lib-v11/full-api"
          },
          {
            "text": "V11 运行命令",
            "link": "/projects/onebot-kotlin-lib-v11/run-commands"
          },
          {
            "text": "V11 Kotlin API (KDoc)",
            "link": "/projects/onebot-kotlin-lib-v11/kotlin-doc"
          }
        ]
      }
    ],
    "/projects/onebot-kotlin-lib-v12/": [
      {
        "text": "onebot-kotlin-lib-v12",
        "items": [
          {
            "text": "V12 总览",
            "link": "/projects/onebot-kotlin-lib-v12/"
          },
          {
            "text": "V12 最小 API",
            "link": "/projects/onebot-kotlin-lib-v12/minimal-api"
          },
          {
            "text": "V12 事件监听",
            "link": "/projects/onebot-kotlin-lib-v12/event-listening"
          },
          {
            "text": "V12 通信模式",
            "link": "/projects/onebot-kotlin-lib-v12/transport-modes"
          },
          {
            "text": "V12 完整 API",
            "link": "/projects/onebot-kotlin-lib-v12/full-api"
          },
          {
            "text": "V12 运行命令",
            "link": "/projects/onebot-kotlin-lib-v12/run-commands"
          },
          {
            "text": "V12 Kotlin API (KDoc)",
            "link": "/projects/onebot-kotlin-lib-v12/kotlin-doc"
          }
        ]
      }
    ],
    "/projects/": [
      {
        "text": "Projects",
        "items": [
          {
            "text": "项目总览",
            "link": "/projects/"
          },
          {
            "text": "onebot-kotlin-lib",
            "link": "/projects/onebot-kotlin-lib/"
          },
          {
            "text": "onebot-kotlin-lib-v11",
            "link": "/projects/onebot-kotlin-lib-v11/"
          },
          {
            "text": "onebot-kotlin-lib-v12",
            "link": "/projects/onebot-kotlin-lib-v12/"
          }
        ]
      }
    ],
    "/": [
      {
        "text": "Projects",
        "items": [
          {
            "text": "项目总览",
            "link": "/projects/"
          },
          {
            "text": "onebot-kotlin-lib",
            "link": "/projects/onebot-kotlin-lib/"
          },
          {
            "text": "onebot-kotlin-lib-v11",
            "link": "/projects/onebot-kotlin-lib-v11/"
          },
          {
            "text": "onebot-kotlin-lib-v12",
            "link": "/projects/onebot-kotlin-lib-v12/"
          }
        ]
      },
      {
        "text": "Examples",
        "items": [
          {
            "text": "Markdown Examples",
            "link": "/markdown-examples"
          },
          {
            "text": "Runtime API Examples",
            "link": "/api-examples"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/qfys521"
    }
  ]
}

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.