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": "/start"
    },
    {
      "text": "导航",
      "link": "/nav/index"
    },
    {
      "text": "主站",
      "link": "https://pengdonglai.com"
    },
    {
      "text": "博客",
      "link": "https://blog.pengdonglai.com"
    }
  ],
  "footer": {
    "message": "Powered by VitePress",
    "copyright": "海星来来@Since2024"
  },
  "sidebar": [
    {
      "text": "从这里开始",
      "items": [
        {
          "text": "建站说明",
          "link": "/start"
        }
      ]
    },
    {
      "text": "随机二次元图片",
      "items": [
        {
          "text": "关于 API 的说明",
          "link": "/random-anime-imgs/"
        },
        {
          "text": "v1 参数说明",
          "link": "/random-anime-imgs/params"
        },
        {
          "text": "v2 参数说明",
          "link": "/random-anime-imgs/params2"
        },
        {
          "text": "返回结果",
          "link": "/random-anime-imgs/results"
        }
      ]
    },
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/umaru2001"
    }
  ]
}

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.