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

{
  "returnToTopLabel": "返回顶部",
  "sidebarMenuLabel": "目录",
  "lastUpdatedText": "最后更新时间",
  "logo": "/assets/logo.jpg",
  "nav": [
    {
      "text": "账号注册",
      "link": "/422/register.html"
    },
    {
      "text": "版本介绍",
      "link": "/versions.html"
    },
    {
      "text": "游戏下载",
      "link": "/downloads.html"
    },
    {
      "text": "免责声明",
      "link": "/1345/statement.html"
    },
    {
      "text": "友情赞助",
      "link": "/422/support.html"
    }
  ],
  "outlineTitle": "页面导航",
  "docFooter": {
    "prev": false,
    "next": false
  },
  "sidebar": {
    "/422/": [
      {
        "text": "五职业飞升版本",
        "items": [
          {
            "text": "游戏下载和安全配置",
            "link": "/422/security/setting"
          },
          {
            "text": "新人必看",
            "link": "/422/newer"
          },
          {
            "text": "升级指南",
            "link": "/422/5-guide"
          },
          {
            "text": "小金人",
            "link": "/422/gold-statue"
          },
          {
            "text": "黑市商人",
            "link": "/422/trader"
          },
          {
            "text": "高级玩家安置计划",
            "link": "/422/transfer"
          },
          {
            "text": "怪物类",
            "collapsed": true,
            "items": [
              {
                "text": "魔化怪分布图",
                "link": "/422/magic-pos"
              },
              {
                "text": "地图BOSS",
                "link": "/422/map-boss"
              },
              {
                "text": "地宫BOSS",
                "link": "/422/undermap-boss"
              }
            ]
          },
          {
            "text": "材料类",
            "collapsed": true,
            "items": [
              {
                "text": "奇珍1级到10级",
                "link": "/422/material/qizhen-material"
              }
            ]
          },
          {
            "text": "任务类",
            "collapsed": true,
            "items": [
              {
                "text": "修真总动员任务攻略",
                "link": "/422/task/xiuzhen-task"
              },
              {
                "text": "星宿北斗任务攻略",
                "link": "/422/task/xingxiu-task"
              }
            ]
          },
          {
            "text": "装备类",
            "collapsed": true,
            "items": [
              {
                "text": "135级门派法宝碎片",
                "link": "/422/gear/magic-gear"
              }
            ]
          }
        ]
      }
    ],
    "/1345/": [
      {
        "text": "十职业飞升版本",
        "items": [
          {
            "text": "游戏下载和安全配置",
            "link": "/1345/security/setting"
          },
          {
            "text": "版本介绍",
            "link": "/1345/introduce"
          },
          {
            "text": "小金人",
            "link": "/1345/gold-statue"
          }
        ]
      }
    ]
  },
  "footer": {
    "message": "本站非赢利性质诛仙私服，任何人均可直接进入游戏，仅供个人娱乐、探讨、研究。 如果您认为我们侵犯了您的权益，请联系我们删除。",
    "copyright": "Copyright © 2024-present lgzx.fun"
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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