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": "/Gogs-Jenkins-docker-environment-build"
    },
    {
      "text": "联系我admin@475462.xyz",
      "link": "mailto:admin@475462.xyz"
    }
  ],
  "sidebar": [
    {
      "text": "实战教程",
      "items": [
        {
          "text": "Gogs、Jenkins、docker CI/CD 本地环境搭建",
          "link": "/Gogs-Jenkins-docker-environment-build"
        },
        {
          "text": "windows openWrt旁路由搭建",
          "link": "/Windows-Hyper-V-buile-OpenWrt-other-router"
        },
        {
          "text": "零成本全栈 AI 代理网站搭建",
          "link": "/Free-AI-Website-For-Agents.md"
        },
        {
          "text": "文档管理",
          "link": "/wiki-manage.md"
        },
        {
          "text": "lobe agent 安装（支持中文）",
          "link": "/lobe-ai-agent-install"
        }
      ]
    },
    {
      "text": "变现",
      "items": [
        {
          "text": "维修",
          "link": "/fixman.md"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/pan45724/my-wiki"
    }
  ],
  "search": {
    "provider": "local"
  },
  "sitemap": {
    "hostname": "https://882299.xyz"
  }
}

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.