Skip to content

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:

md
<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

{
  "logo": "",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "新手入门",
      "link": "/guide/choose-proxy-or-vpn"
    },
    {
      "text": "机场推荐",
      "link": "/recommend/best-overall"
    },
    {
      "text": "机场评测",
      "link": "/reviews/longmaoyun"
    },
    {
      "text": "客户端教程",
      "link": "/clients/windows/clash-for-windows"
    },
    {
      "text": "免费节点",
      "link": "/free-nodes/daily-share"
    },
    {
      "text": "常见问题",
      "link": "/faq/how-to-setup-ipv6"
    }
  ],
  "sidebar": {
    "/guide/": [
      {
        "text": "新手入门",
        "items": [
          {
            "text": "什么是机场?什么是科学上网?",
            "link": "/guide/what-is-airport-proxy"
          },
          {
            "text": "如何选择合适的机场",
            "link": "/guide/how-to-choose"
          },
          {
            "text": "电报、飞机设置中文",
            "link": "/guide/setup-telegram-to-zhcn"
          },
          {
            "text": "安全与合规提示",
            "link": "/guide/safety-tips"
          }
        ]
      }
    ],
    "/faq/": [
      {
        "text": "常见问题",
        "items": [
          {
            "text": "如何开启IPV6",
            "link": "/faq/how-to-setup-ipv6"
          },
          {
            "text": "如何选择合适的机场",
            "link": "/guide/how-to-choose"
          }
        ]
      }
    ],
    "/recommend/": [
      {
        "text": "机场推荐",
        "items": [
          {
            "text": "综合推荐榜单",
            "link": "/recommend/best-overall"
          },
          {
            "text": "流媒体解锁推荐",
            "link": "/recommend/for-streaming"
          },
          {
            "text": "游戏加速推荐",
            "link": "/recommend/for-gaming"
          },
          {
            "text": "优惠活动与折扣",
            "link": "/recommend/discount"
          }
        ]
      }
    ],
    "/reviews/": [
      {
        "text": "机场评测",
        "items": [
          {
            "text": "龙猫云评测",
            "collapsed": true,
            "items": [
              {
                "text": "龙猫云评测",
                "link": "/reviews/longmaoyun/index"
              },
              {
                "text": "龙猫云评测(第一次复测)",
                "link": "/reviews/longmaoyun/v2"
              },
              {
                "text": "龙猫云评测(第二次复测)",
                "link": "/reviews/longmaoyun/v3"
              }
            ]
          },
          {
            "text": "酷酷云评测",
            "link": "/reviews/kukuyun"
          },
          {
            "text": "肥猫云评测",
            "link": "/reviews/feimaoyun"
          },
          {
            "text": "闪狐云评测",
            "link": "/reviews/shanhuyun"
          },
          {
            "text": "小旋风评测",
            "link": "/reviews/xiaoxuanfeng"
          },
          {
            "text": "青云梯评测",
            "link": "/reviews/qingyunti"
          },
          {
            "text": "银河云评测",
            "link": "/reviews/yinheyun"
          },
          {
            "text": "TNTCloud评测",
            "link": "/reviews/tntcloud"
          },
          {
            "text": "飞天猪评测",
            "link": "/reviews/feitianzhu"
          },
          {
            "text": "良心云评测",
            "link": "/reviews/liangxinyun"
          },
          {
            "text": "MESL评测",
            "collapsed": true,
            "items": [
              {
                "text": "MESL评测",
                "link": "/reviews/mesl/index"
              },
              {
                "text": "MESL评测(第一次复测)",
                "link": "/reviews/mesl/v2"
              }
            ]
          },
          {
            "text": "ikuuu评测",
            "link": "/reviews/ikuuu"
          },
          {
            "text": "光速云评测",
            "link": "/reviews/guangsuyun"
          },
          {
            "text": "绿叶云评测",
            "link": "/reviews/lvye"
          },
          {
            "text": "西部数据评测",
            "link": "/reviews/xibushuju"
          },
          {
            "text": "CrushCloud评测",
            "link": "/reviews/crushcloud"
          },
          {
            "text": "狗狗加速评测",
            "link": "/reviews/gougoujiasu"
          },
          {
            "text": "守候机场评测",
            "link": "/reviews/shouhou"
          },
          {
            "text": "SpeedCat 评测",
            "link": "/reviews/speedcat"
          },
          {
            "text": "ikuuu 评测",
            "link": "/reviews/ikuuu"
          },
          {
            "text": "奶瓶机场评测",
            "link": "/reviews/naiping"
          },
          {
            "text": "绿叶机场评测",
            "link": "/reviews/lvye"
          },
          {
            "text": "白月光机场评测",
            "link": "/reviews/baiyueguang"
          },
          {
            "text": "一分机场评测",
            "link": "/reviews/yifen"
          }
        ]
      }
    ],
    "/clients/": [
      {
        "text": "Windows 客户端",
        "items": [
          {
            "text": "Clash for Windows 教程",
            "link": "/clients/windows/clash-for-windows"
          },
          {
            "text": "Clash Party 教程",
            "link": "/clients/windows/clashparty"
          },
          {
            "text": "v2rayN 教程",
            "link": "/clients/windows/v2rayn"
          }
        ]
      },
      {
        "text": "macOS 客户端",
        "items": [
          {
            "text": "Clash for Mac 教程",
            "link": "/clients/macos/clash-for-mac"
          },
          {
            "text": "Clash Verge Rev 教程",
            "link": "/clients/macos/clash-verge-rev"
          }
        ]
      },
      {
        "text": "Android 客户端",
        "items": [
          {
            "text": "Clash for Android 教程",
            "link": "/clients/android/clash-for-android"
          },
          {
            "text": "v2rayNG 教程",
            "link": "/clients/android/v2rayng"
          }
        ]
      },
      {
        "text": "iOS / iPadOS 客户端",
        "items": [
          {
            "text": "Shadowrocket 教程",
            "link": "/clients/ios/shadowrocket"
          },
          {
            "text": "Stash 教程",
            "link": "/clients/ios/stash"
          }
        ]
      }
    ],
    "/free-nodes/": [
      {
        "text": "免费节点",
        "items": [
          {
            "text": "推荐与分享说明",
            "link": "/free-nodes/daily-share"
          },
          {
            "text": "免费节点常见问题",
            "link": "/free-nodes/faq"
          }
        ]
      }
    ]
  },
  "socialLinks": [],
  "footer": {
    "message": "本站内容仅作学习与技术交流,请遵守当地法律法规合理使用网络工具。",
    "copyright": "Copyright © 2025 v2raywiki.com"
  },
  "outline": {
    "level": [
      2,
      3
    ],
    "label": "本页目录"
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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

本站内容仅作学习与技术交流,请遵守当地法律法规合理使用网络工具。