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": "Babylon.js 勉強会とは？",
      "link": "/what-is-babylonjs-study"
    }
  ],
  "sidebar": [
    {
      "items": [
        {
          "text": "これまでの活動",
          "link": "/activities"
        },
        {
          "text": "カメラについて",
          "link": "/cameras"
        },
        {
          "text": "お役立ちリンク集",
          "link": "/links"
        },
        {
          "text": "逆引きリファレンス",
          "link": "/references"
        },
        {
          "text": "マークダウン記法例",
          "link": "/markdown-examples"
        },
        {
          "text": "API 例",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/babylon-js-jp-community"
    },
    {
      "icon": "discord",
      "link": "https://discord.gg/uWaWQYgxCE"
    },
    {
      "icon": "youtube",
      "link": "https://www.youtube.com/@Babylonjs-wd3cz"
    }
  ]
}

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.