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

{
  "search": {
    "provider": "local"
  },
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "下载软件",
      "link": "/downloadFile"
    },
    {
      "text": "API文档",
      "link": "/note"
    },
    {
      "text": "登录/注册",
      "link": "https://sms.ikun.run"
    }
  ],
  "sidebar": [
    {
      "text": "API文档",
      "items": [
        {
          "text": "使用说明",
          "link": "/note"
        },
        {
          "text": "用户登录",
          "link": "/userLogin"
        },
        {
          "text": "获取用户信息",
          "link": "/getUserInfo"
        },
        {
          "text": "获取价格表",
          "link": "/getPriceTable"
        },
        {
          "text": "获取手机号",
          "link": "/getPhoneNum"
        },
        {
          "text": "获取验证码",
          "link": "/getCaptcha"
        },
        {
          "text": "发送短信",
          "link": "/sendSMS"
        },
        {
          "text": "获取发短信回执",
          "link": "/getReceipt"
        },
        {
          "text": "释放手机号",
          "link": "/releasePhoneNum"
        },
        {
          "text": "拉黑手机号",
          "link": "/blockPhoneNum"
        },
        {
          "text": "项目表",
          "link": "/projectTable"
        },
        {
          "text": "国家代码表",
          "link": "/countryCodeTable.md"
        }
      ]
    },
    {
      "text": "卡商端使用说明",
      "items": [
        {
          "text": "猫池上卡接码",
          "link": "/modemPool"
        },
        {
          "text": "API上卡接码",
          "link": "/apiSendSMS"
        },
        {
          "text": "手动上卡接码",
          "link": "/manualOperation"
        }
      ]
    },
    {
      "text": "客户端使用说明",
      "items": [
        {
          "text": "客户端接码（桌面端）",
          "link": "/userDesktopClient"
        },
        {
          "text": "客户端接码（移动端）",
          "link": "/userMobileClient"
        },
        {
          "text": "API接码",
          "link": "/apiGetSMS"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": {
        "svg": "<svg t=\"1721908636773\" class=\"icon\" viewBox=\"0 0 1024 1024\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" p-id=\"4406\" width=\"200\" height=\"200\"><path d=\"M679.424 746.862l84.005-395.996c7.424-34.852-12.581-48.567-35.438-40.009L234.277 501.138c-33.72 13.13-33.134 32-5.706 40.558l126.282 39.424 293.156-184.576c13.714-9.143 26.295-3.986 16.018 5.157L426.898 615.973l-9.143 130.304c13.13 0 18.871-5.706 25.71-12.581l61.696-59.429 128 94.282c23.442 13.129 40.01 6.29 46.3-21.724zM1024 512c0 282.843-229.157 512-512 512S0 794.843 0 512 229.157 0 512 0s512 229.157 512 512z\" fill=\"#1296DB\" p-id=\"4407\"></path></svg>"
      },
      "link": "https://t.me/+nzzg5NcAB2A0YTc1"
    }
  ],
  "footer": {
    "message": "鲁123456789备",
    "copyright": "Copyright © 2001 - 2024"
  }
}

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.