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

{
  "search": {
    "provider": "local"
  },
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Examples",
      "link": "/examples/markdown-examples"
    }
  ],
  "sidebar": {
    "tech": [
      {
        "items": [
          {
            "text": "尝试在现有next.js项目中集成shadcn遇到的坑",
            "link": "/tech/shadcn-nextjs-integration-problems"
          },
          {
            "text": "(转)怎么学习开发网站",
            "link": "/tech/how-to-learn-website-development"
          },
          {
            "text": "VSCode解决终端的中文乱码问题",
            "link": "/tech/vscode-terminal-Chinese-garbled-characters"
          },
          {
            "text": "electron开发之mac签名和公证",
            "link": "/tech/electron-mac-sign"
          },
          {
            "text": "记一次线上mysql启动失败的问题",
            "link": "/tech/mysql-error"
          },
          {
            "text": "如何用vitepress+cloudflare pages搭建博客",
            "link": "/tech/vitepress-blog"
          }
        ]
      }
    ],
    "other": [
      {
        "items": [
          {
            "text": "如何挖掘价值百万的需求",
            "link": "/other/how-to-uncover-million-dollar-needs"
          },
          {
            "text": "出海基本功之如何使用semrush寻找关键词机会",
            "link": "/other/how-to-use-semrush-to-find-opportunities"
          },
          {
            "text": "【播客笔记】蛋壳的出海赚美金经历访谈",
            "link": "/other/note-danke-overseas-podcast"
          },
          {
            "text": "注册谷歌云获取300刀赠金配合lobechat免费使用claude3.5(需绑卡)",
            "link": "/other/register-gcp-get-claude3.5-free"
          },
          {
            "text": "闲鱼学习法",
            "link": "/other/xianyu-based-learning"
          }
        ]
      }
    ],
    "examples": [
      {
        "text": "Examples",
        "items": [
          {
            "text": "Markdown Examples",
            "link": "/examples/markdown-examples"
          },
          {
            "text": "API Examples",
            "link": "/examples/api-examples"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/mundane799699"
    }
  ]
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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