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": "https://technod.cn"
    }
  ],
  "sidebar": [
    {
      "text": "开始",
      "link": "/start"
    },
    {
      "text": "我的VitePress配置",
      "items": [
        {
          "text": "集成Valine评论系统",
          "link": "/vitepress/valine"
        },
        {
          "text": "静态资源打包配置",
          "link": "/vitepress/static-copy"
        }
      ]
    },
    {
      "text": "其他",
      "items": [
        {
          "text": "KMS激活软件下载与使用说明",
          "link": "/kms"
        },
        {
          "text": "Windows中docker安装教程",
          "link": "/12/win-docker"
        }
      ]
    },
    {
      "text": "Markdown语法",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/nodjoy"
    }
  ]
}

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.