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": "/images/icon/icon.png",
"nav": [
{
"text": "主页",
"link": "/"
},
{
"text": "资源",
"items": [
{
"text": "落梦其他网站",
"items": [
{
"text": "文件夹",
"link": " http://lmgzs.fun:444/files/",
"target": "_self"
},
{
"text": "落梦 Skin (皮肤站)",
"link": "http://lmgzs.fun:888/"
}
]
},
{
"text": "本站壁纸",
"items": [
{
"text": "115678062_p0",
"link": "http://lmgzs.fun:444/files/img/115678062_p0.png",
"target": "_self"
},
{
"text": "115678062_p1",
"link": "http://lmgzs.fun:444/files/img/115678062_p1.png",
"target": "_self"
},
{
"text": "102545981_p0",
"link": "http://lmgzs.fun:444/files/img/102545981_p0.jpg",
"target": "_self"
}
]
},
{
"text": "实用网站",
"items": [
{
"text": "网站收藏夹",
"link": "/网站收藏夹/网站收藏夹-index"
},
{
"text": "静态站点",
"link": "/静态站点/静态站点-index"
}
]
}
]
},
{
"text": "示例",
"items": [
{
"text": "Markdown Examples",
"link": "/markdown-examples"
},
{
"text": "API Examples",
"link": "/api-examples"
},
{
"text": "测试",
"link": "/测试/测试-index"
}
]
},
{
"text": "文档",
"items": [
{
"text": "落梦工作室",
"link": "/落梦工作室/落梦工作室文档-index"
},
{
"text": "啸霄领域",
"link": "/啸霄领域/啸霄领域文档-index"
},
{
"text": "其他",
"link": "/其他/其他文档-index"
},
{
"text": "合作须知",
"link": "/合作须知/合作须知-index"
}
]
}
],
"search": {
"provider": "local"
},
"sidebar": {
"/测试/": {
"base": "/测试/",
"items": [
{
"text": "文件夹1",
"items": [
{
"text": "1",
"link": "文件夹1/文件1"
},
{
"text": "文件夹11",
"items": [
{
"text": "11",
"link": "文件夹1/文件夹11/文件11"
}
],
"collapsed": true
},
{
"text": "文件夹12",
"items": [
{
"text": "12",
"link": "文件夹1/文件夹12/文件12"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "文件夹2",
"items": [
{
"text": "文件2",
"link": "文件夹2/文件2"
}
],
"collapsed": true
}
]
},
"/落梦工作室/": {
"base": "/落梦工作室/",
"items": [
{
"text": "帮助",
"items": [
{
"text": "帮助",
"link": "帮助/帮助"
},
{
"text": "落梦域",
"items": [
{
"text": "落梦域_Java 1.19.2 模组服 帮助",
"items": [
{
"text": "落梦域_Java 1.19.2 模组服 帮助",
"link": "帮助/落梦域/落梦域_Java-1.19.2-模组服-帮助/0-落梦域_Java-1.19.2-模组服-帮助"
},
{
"text": "更新日志",
"items": [
{
"text": "落梦域_Java 1.19.2 模组服 更新日志",
"link": "帮助/落梦域/落梦域_Java-1.19.2-模组服-帮助/更新日志/落梦域_Java-1.19.2-模组服-更新日志"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "落梦域_Java 1.20.1 互通服 帮助",
"items": [
{
"text": "落梦域_Java 1.20.1 互通服 帮助",
"link": "帮助/落梦域/落梦域_Java-1.20.1-互通服-帮助/0-落梦域_Java-1.20.1-互通服-帮助"
},
{
"text": "更新日志",
"items": [
{
"text": "落梦域_Java 1.20.1 互通服 更新日志",
"link": "帮助/落梦域/落梦域_Java-1.20.1-互通服-帮助/更新日志/落梦域_Java-1.20.1-互通服-更新日志"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "落梦域_Java 1.20.1 模组服 帮助",
"items": [
{
"text": "落梦域_Java 1.20.1 模组服 帮助",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/0-落梦域_Java-1.20.1-模组服-帮助"
},
{
"text": "1 简洁教程",
"items": [
{
"text": "♩简洁教程",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/1-简洁教程/0-简洁教程"
},
{
"text": "1. 注册皮肤站账号",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/1-简洁教程/1-注册皮肤站账号"
},
{
"text": "2. 给启动器添加认证服务器",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/1-简洁教程/2-给启动器添加认证服务器"
},
{
"text": "3. 下载Minecraft",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/1-简洁教程/3-下载Minecraft"
},
{
"text": "4. 安装特定模组",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/1-简洁教程/4-安装特定模组"
},
{
"text": "5. 安装枪包",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/1-简洁教程/5-安装枪包"
}
],
"collapsed": true
},
{
"text": "2 详细教程",
"items": [
{
"text": "♬详细教程",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/0-详细教程"
},
{
"text": "1. 注册皮肤站账号",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/1-注册皮肤站账号"
},
{
"text": "2. 下载 Java",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/2-下载 Java"
},
{
"text": "3. 下载启动器",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/3-下载启动器"
},
{
"text": "4. 给启动器添加认证服务器",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/4-给启动器添加认证服务器"
},
{
"text": "5. 下载Minecraft",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/5.0-下载Minecraft"
},
{
"text": "5.1 添加游戏目录",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/5.1-添加游戏目录"
},
{
"text": "5.2 设置版本隔离",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/5.2-设置版本隔离"
},
{
"text": "5.3 下载Minecraft",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/5.3-下载Minecraft"
},
{
"text": "6. 安装特定模组",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/6-安装特定模组"
},
{
"text": "7. 安装枪包",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/2-详细教程/7-安装枪包"
}
],
"collapsed": true
},
{
"text": "3 模组游玩教程和注意事项",
"items": [
{
"text": "♬模组游玩教程/注意事项",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/3-模组游玩教程和注意事项/模组游玩教程和注意事项"
}
],
"collapsed": true
},
{
"text": "4 更新模组",
"items": [
{
"text": "♬更新模组",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/4-更新模组/更新模组"
}
],
"collapsed": true
},
{
"text": "5 便民服务",
"items": [
{
"text": "♬便民服务",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/5-便民服务/0-便民服务"
},
{
"text": "插件使用教程",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/5-便民服务/1-插件使用教程"
},
{
"text": "模组替换器使用教程",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/5-便民服务/2-模组替换器使用教程"
},
{
"text": "网页地图",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/5-便民服务/3-网页地图"
}
],
"collapsed": true
},
{
"text": "6 问答",
"items": [
{
"text": "♬问答",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/6-问答/问答"
}
],
"collapsed": true
},
{
"text": "7 整合包",
"items": [
{
"text": "整合包",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/7-整合包/0-整合包"
}
],
"collapsed": true
},
{
"text": "8 文件结构",
"items": [
{
"text": "♬文件结构",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/8-文件结构/0-文件结构"
}
],
"collapsed": true
},
{
"text": "9 服务器设置",
"items": [
{
"text": "服务器启动",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/9-服务器设置/1-服务器启动"
},
{
"text": "服务器设置",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/9-服务器设置/0-服务器设置"
},
{
"text": "模组配置文件",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/9-服务器设置/3-模组配置文件"
},
{
"text": "2 服务器地图地形",
"items": [
{
"text": "服务器地图地形",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/9-服务器设置/2-服务器地图地形/0-服务器地图地形"
},
{
"text": "模组(6个)",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/9-服务器设置/2-服务器地图地形/1-模组"
},
{
"text": "数据包(2个)",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/9-服务器设置/2-服务器地图地形/2-数据包"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "10 更新日志",
"items": [
{
"text": "落梦域_Java 1.20.1 模组服 更新日志",
"link": "帮助/落梦域/落梦域_Java-1.20.1-模组服-帮助/10-更新日志/落梦域_Java-1.20.1-模组服-更新日志"
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "更新",
"items": [
{
"text": "更新日志",
"link": "更新/0-更新日志"
},
{
"text": "设备",
"items": [
{
"text": "设备 更新日志",
"link": "更新/设备/设备-更新日志"
}
],
"collapsed": true
},
{
"text": "文档",
"items": [
{
"text": "文档 更新日志",
"link": "更新/文档/文档-更新日志"
},
{
"text": "文档 计划更新",
"link": "更新/文档/文档-计划更新"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "公告",
"items": [
{
"text": "公告",
"link": "公告/公告"
},
{
"text": "落梦域",
"items": [
{
"text": "落梦域 公告",
"link": "公告/落梦域/落梦域-公告"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "贡献",
"items": [
{
"text": "贡献",
"link": "贡献/贡献"
}
],
"collapsed": true
}
]
},
"/啸霄领域/": {
"base": "/啸霄领域/",
"items": [
{
"text": "帮助",
"items": [
{
"text": "帮助",
"link": "帮助/帮助"
},
{
"text": "啸霄领域",
"items": [
{
"text": "啸霄领域_基岩 1.20.1 基岩服 帮助",
"link": "帮助/啸霄领域/啸霄领域_基岩-1.20.1-基岩服-帮助"
},
{
"text": "啸霄领域_Java 1.21.0 互通服 帮助",
"link": "帮助/啸霄领域/啸霄领域_Java-1.21.0-互通服-帮助"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "地图",
"items": [
{
"text": "3D地图",
"link": "地图/地图"
}
],
"collapsed": true
},
{
"text": "更新",
"items": [
{
"text": "更新日志",
"link": "更新/更新日志"
},
{
"text": "啸霄领域",
"items": [
{
"text": "啸霄领域_基岩 1.20.1 基岩服 更新日志",
"link": "更新/啸霄领域/啸霄领域_基岩-1.20.1-基岩服-更新日志"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "公告",
"items": [
{
"text": "公告",
"link": "公告/公告"
},
{
"text": "啸霄领域",
"items": [
{
"text": "啸霄领域 公告",
"link": "公告/啸霄领域/啸霄领域-公告"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "贡献",
"items": [
{
"text": "贡献",
"link": "贡献/贡献"
}
],
"collapsed": true
}
]
},
"/其他/": {
"base": "/其他/",
"items": [
{
"text": "我的世界模组",
"items": [
{
"text": "我的世界模组",
"link": "我的世界模组/我的世界模组"
},
{
"text": "旅行地图journeymap",
"items": [
{
"text": "其他 帮助",
"link": "我的世界模组/旅行地图journeymap/旅行地图journeymap"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "Apache",
"items": [
{
"text": "Apache",
"link": "Apache/Apache"
},
{
"text": "多站点独立配置",
"items": [
{
"text": "多站点独立配置",
"link": "Apache/多站点独立配置/多站点独立配置"
}
],
"collapsed": true
},
{
"text": "目录索引",
"items": [
{
"text": "目录索引",
"link": "Apache/目录索引/目录索引"
},
{
"text": "目录索引美化",
"link": "Apache/目录索引/目录索引美化"
},
{
"text": "apaxy",
"items": [
{
"text": "Apaxy",
"link": "Apache/目录索引/apaxy/README"
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "Linux",
"items": [
{
"text": "其他 安装和设置ubuntu 22.04.3 live server amd64",
"link": "Linux/安装和设置ubuntu-22.04.3-live-server-amd64"
}
],
"collapsed": true
},
{
"text": "VitePress",
"items": [
{
"text": "使用的第三方资源",
"link": "VitePress/VitePress"
},
{
"text": "包",
"items": [
{
"text": "markdown it",
"items": [
{
"text": "markdown it <!-- omit in toc -->",
"link": "VitePress/包/markdown-it/README"
},
{
"text": "@mdit",
"items": [
{
"text": "plugin img size",
"items": [
{
"text": "@mdit/plugin img size",
"link": "VitePress/包/markdown-it/@mdit/plugin-img-size/README"
},
{
"text": "VitePress中使用",
"link": "VitePress/包/markdown-it/@mdit/plugin-img-size/VitePress中使用"
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "typescript",
"items": [
{
"text": "@types",
"items": [
{
"text": "node",
"items": [
{
"text": "Installation",
"link": "VitePress/包/typescript/@types/node/README"
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "vitepress plugin tabs",
"items": [
{
"text": "vitepress plugin tabs",
"link": "VitePress/包/vitepress-plugin-tabs/official-website"
},
{
"text": "vitepress plugin tabs",
"link": "VitePress/包/vitepress-plugin-tabs/README"
}
],
"collapsed": true
},
{
"text": "vitepress sidebar",
"items": [
{
"text": "🔌 VitePress Sidebar",
"link": "VitePress/包/vitepress-sidebar/README"
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "Windows",
"items": [
{
"text": "Windows",
"link": "Windows/Windows"
},
{
"text": "符号链接",
"items": [
{
"text": "符号链接",
"link": "Windows/符号链接/符号链接"
}
],
"collapsed": true
},
{
"text": "右键创建自定义后缀文件",
"items": [
{
"text": "右键创建自定义后缀文件",
"link": "Windows/右键创建自定义后缀文件/右键创建自定义后缀文件"
}
],
"collapsed": true
}
],
"collapsed": true
}
]
},
"/合作须知/": {
"base": "/合作须知/",
"items": [
{
"text": "多平台管理员",
"items": [
{
"text": "多平台管理员须知",
"link": "多平台管理员/多平台管理员"
}
],
"collapsed": true
},
{
"text": "设备",
"items": [
{
"text": "设备合作须知",
"link": "设备/设备-合作"
}
],
"collapsed": true
},
{
"text": "文档",
"items": [
{
"text": "文档 合作",
"link": "文档/文档-合作"
}
],
"collapsed": true
}
]
},
"/成员/": {
"base": "/成员/",
"items": [
{
"text": "开发者",
"items": [
{
"text": "开发者",
"link": "开发者/开发者"
},
{
"text": "落梦工作室",
"items": [
{
"text": "冰影狼",
"items": [
{
"text": "冰影狼",
"link": "开发者/落梦工作室/冰影狼/冰影狼"
}
],
"collapsed": true
},
{
"text": "尘星",
"items": [
{
"text": "尘星",
"link": "开发者/落梦工作室/尘星/尘星"
}
],
"collapsed": true
},
{
"text": "肥猫",
"items": [
{
"text": "肥猫",
"link": "开发者/落梦工作室/肥猫/肥猫"
}
],
"collapsed": true
},
{
"text": "诺诺",
"items": [
{
"text": "诺诺",
"link": "开发者/落梦工作室/诺诺/诺诺"
}
],
"collapsed": true
},
{
"text": "我梦",
"items": [
{
"text": "我梦",
"link": "开发者/落梦工作室/我梦/我梦"
}
],
"collapsed": true
},
{
"text": "鸭籽",
"items": [
{
"text": "鸭籽",
"link": "开发者/落梦工作室/鸭籽/鸭籽"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "啸霄领域",
"items": [
{
"text": "霄杨",
"items": [
{
"text": "霄杨",
"link": "开发者/啸霄领域/霄杨/霄杨"
}
],
"collapsed": true
},
{
"text": "ebwnqm",
"items": [
{
"text": "ebwnqm",
"link": "开发者/啸霄领域/ebwnqm/ebwnqm"
}
],
"collapsed": true
},
{
"text": "MewingBoot58565",
"items": [
{
"text": "MewingBoot58565",
"link": "开发者/啸霄领域/MewingBoot58565/MewingBoot58565"
}
],
"collapsed": true
},
{
"text": "shi",
"items": [
{
"text": "shi",
"link": "开发者/啸霄领域/shi/shi"
}
],
"collapsed": true
},
{
"text": "W0DNMD",
"items": [
{
"text": "W0DNMD",
"link": "开发者/啸霄领域/W0DNMD/W0DNMD"
}
],
"collapsed": true
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "外部成员",
"items": [
{
"text": "外部成员",
"link": "外部成员/外部成员"
},
{
"text": "_xiSevoecall_♡",
"items": [
{
"text": "_xiSevoecall_♡",
"link": "外部成员/_xiSevoecall_♡/_xiSevoecall_♡"
}
],
"collapsed": true
},
{
"text": "阿伟",
"items": [
{
"text": "阿伟",
"link": "外部成员/阿伟/阿伟"
}
],
"collapsed": true
},
{
"text": "朝久暮",
"items": [
{
"text": "朝久暮",
"link": "外部成员/朝久暮/朝久暮"
}
],
"collapsed": true
},
{
"text": "a",
"items": [
{
"text": "a",
"link": "外部成员/a/a"
}
],
"collapsed": true
}
],
"collapsed": true
}
]
}
},
"socialLinks": [
{
"icon": "github",
"link": "/"
},
{
"icon": {
"svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"128\" height=\"128\" viewBox=\"0 0 24 24\"><path fill=\"#0891b2\" d=\"M18.223 3.086a1.25 1.25 0 0 1 0 1.768L17.08 5.996h1.17A3.75 3.75 0 0 1 22 9.747v7.5a3.75 3.75 0 0 1-3.75 3.75H5.75A3.75 3.75 0 0 1 2 17.247v-7.5a3.75 3.75 0 0 1 3.75-3.75h1.166L5.775 4.855a1.25 1.25 0 0 1 1.767-1.768l2.652 2.652q.119.119.198.257h3.213q.08-.14.199-.258l2.651-2.652a1.25 1.25 0 0 1 1.768 0m.027 5.42H5.75a1.25 1.25 0 0 0-1.247 1.157l-.003.094v7.5c0 .659.51 1.198 1.157 1.246l.093.004h12.5a1.25 1.25 0 0 0 1.247-1.157l.003-.093v-7.5c0-.69-.56-1.25-1.25-1.25m-10 2.5c.69 0 1.25.56 1.25 1.25v1.25a1.25 1.25 0 1 1-2.5 0v-1.25c0-.69.56-1.25 1.25-1.25m7.5 0c.69 0 1.25.56 1.25 1.25v1.25a1.25 1.25 0 1 1-2.5 0v-1.25c0-.69.56-1.25 1.25-1.25\"/></svg>"
},
"link": "https://space.bilibili.com/1915013301"
}
],
"sidebarMenuLabel": "菜单",
"returnToTopLabel": "回到顶部",
"darkModeSwitchLabel": "主题(明/暗)",
"lightModeSwitchTitle": "切换到浅色模式",
"darkModeSwitchTitle": "切换到深色模式",
"outline": {
"level": "deep",
"label": "页面导航"
},
"docFooter": {
"prev": "上一页",
"next": "下一页"
},
"footer": {
"message": "Released under the MIT License.",
"copyright": "Copyright © 2019-present 落梦工作室"
}
}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.