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": "/downloads"
    }
  ],
  "sidebar": [
    {
      "text": "用户文档",
      "items": [
        {
          "text": "特性",
          "link": "/features"
        },
        {
          "text": "安装",
          "link": "/install"
        },
        {
          "text": "配置",
          "link": "/config"
        },
        {
          "text": "常见问题",
          "link": "/faq"
        },
        {
          "text": "上报问题",
          "link": "/report"
        },
        {
          "text": "编写文档",
          "link": "/docs"
        },
        {
          "text": "关于",
          "link": "/about"
        }
      ]
    },
    {
      "text": "开发文档",
      "items": [
        {
          "text": "模拟器api",
          "link": "/device_operation"
        }
      ]
    },
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/pur1fying/blue_archive_auto_script"
    }
  ],
  "lastUpdated": {
    "text": "更新于",
    "formatOptions": {
      "dateStyle": "full",
      "timeStyle": "medium"
    }
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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