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": "/en/"
    },
    {
      "text": "Examples",
      "link": "/en/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "Docker",
      "collapsed": false,
      "items": [
        {
          "text": "Affine Knowledge Platform",
          "link": "/en/docker/affine/"
        },
        {
          "text": "Cloudreve Cloud Drive",
          "link": "/en/docker/cloudreve/"
        },
        {
          "text": "DailyTx Diary",
          "link": "/en/docker/dailytx/"
        },
        {
          "text": "Docmost Documentation",
          "link": "/en/docker/docmost/"
        },
        {
          "text": "Kener Monitoring Tool",
          "link": "/en/docker/kener/"
        },
        {
          "text": "Memos Notes",
          "link": "/en/docker/memos/"
        },
        {
          "text": "NewsNow News Detection",
          "link": "/en/docker/newsnow/"
        },
        {
          "text": "PandaWiki Documentation",
          "link": "/en/docker/PandaWiki/"
        },
        {
          "text": "Uptime-Kuma Monitor",
          "link": "/en/docker/uptime-kuma/"
        },
        {
          "text": "Vaultwarden Password Manager",
          "link": "/en/docker/vaultwarden/"
        },
        {
          "text": "Mazanoke Image Compressor",
          "link": "/en/docker/mazanoke/"
        },
        {
          "text": "Nginx Proxy Manager",
          "link": "/en/docker/nginx-proxy-manager/"
        },
        {
          "text": "Excalidraw Drawing Board",
          "link": "/en/docker/excalidraw/"
        },
        {
          "text": "Changedetection",
          "link": "/en/docker/changedetection/"
        }
      ]
    },
    {
      "text": "Personal Homepage",
      "collapsed": false,
      "items": [
        {
          "text": "Hai-Zou Homepage",
          "link": "/en/homepage/haizou-homepage/"
        },
        {
          "text": "ZYYO Homepage",
          "link": "/en/homepage/zyyo-homepage/"
        }
      ]
    },
    {
      "text": "Server Panel",
      "collapsed": false,
      "items": [
        {
          "text": "BT Panel",
          "link": "/en/panel/bt/"
        },
        {
          "text": "DPanel",
          "link": "/en/panel/dpanel/"
        }
      ]
    }
  ],
  "outline": {
    "level": "deep",
    "label": "目录"
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "search": {
    "provider": "local"
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "en/api-examples.md",
  "filePath": "en/api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.