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
{
"docFooter": {
"prev": "上一篇",
"next": "下一篇"
},
"darkModeSwitchLabel": "外观",
"returnToTopLabel": "返回顶部",
"sidebarMenuLabel": "菜单",
"outline": {
"level": "deep",
"label": "本文目录"
},
"logo": "https://image-host.pages.dev/learn/2024_09_20_dog.png",
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/CcNut0519"
}
],
"nav": [
{
"text": "首页",
"link": "/"
},
{
"text": "关于",
"link": "/Introduction"
}
],
"sidebar": [
{
"text": "🎓内功心法",
"items": [
{
"text": "简介",
"link": "/内功心法/简介"
},
{
"text": "编程学习",
"items": [
{
"text": "C语言",
"link": "/内功心法/编程学习/C语言"
},
{
"text": "CMake",
"link": "/内功心法/编程学习/CMake"
},
{
"text": "JavaScript",
"link": "/内功心法/编程学习/JavaScript"
},
{
"text": "gcc",
"link": "/内功心法/编程学习/gcc"
},
{
"text": "shell",
"link": "/内功心法/编程学习/shell"
}
],
"collapsed": true
},
{
"text": "计算机网络",
"items": [
{
"text": "数据链路层",
"link": "/内功心法/计算机网络/数据链路层"
},
{
"text": "网络层",
"link": "/内功心法/计算机网络/网络层"
},
{
"text": "传输层",
"items": [
{
"text": "TCP",
"link": "/内功心法/计算机网络/传输层/TCP"
},
{
"text": "UDP",
"link": "/内功心法/计算机网络/传输层/UDP"
}
],
"collapsed": true
},
{
"text": "应用层",
"items": []
}
],
"collapsed": true
},
{
"text": "操作系统",
"items": [
{
"text": "Linux",
"items": [
{
"text": "iptables",
"link": "/内功心法/操作系统/Linux/iptables"
},
{
"text": "netfilter",
"link": "/内功心法/操作系统/Linux/netfilter"
},
{
"text": "如何让CPU跑得更快",
"link": "/内功心法/操作系统/Linux/如何让CPU跑得更快"
}
],
"collapsed": true
},
{
"text": "Windows",
"items": [],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "工作",
"items": [
{
"text": "微网",
"items": [
{
"text": "无线定时模块",
"link": "/内功心法/工作/微网/无线定时模块.md"
}
],
"collapsed": true
}
],
"collapsed": true
},
{
"text": "算法&数据结构",
"items": [],
"collapsed": true
},
{
"text": "软件测试",
"items": [],
"collapsed": true
},
{
"text": "为人处世",
"items": []
}
],
"collapsed": true
},
{
"text": "🛠️招式套路",
"items": [
{
"text": "简介",
"link": "/招式套路/简介"
},
{
"text": "工具",
"items": [
{
"text": "git",
"link": "/招式套路/工具/git"
}
]
},
{
"text": "Markdown Examples",
"link": "/招式套路/markdown-examples"
},
{
"text": "Runtime API Examples",
"link": "/招式套路/api-examples"
}
],
"collapsed": true
},
{
"text": "💻领域实践",
"items": [
{
"text": "简介",
"link": "/领域实践/简介"
},
{
"text": "2024",
"items": [
{
"text": "20240829-深圳物联网展",
"link": "/领域实践/2024/20240829-深圳物联网展"
},
{
"text": "20240912-镜像交换机抓包",
"link": "/领域实践/2024/20240912-镜像交换机抓包"
},
{
"text": "20240914-串口（Serial）连接",
"link": "/领域实践/2024/20240914-串口（Serial）连接"
},
{
"text": "10月",
"items": []
},
{
"text": "11月",
"items": []
},
{
"text": "12月",
"items": []
}
]
},
{
"text": "C语言编码规范",
"link": "/领域实践/C语言编码规范"
}
],
"collapsed": true
},
{
"text": "📷摄影",
"items": [
{
"text": "简介",
"link": "/摄影/简介"
},
{
"text": "北京",
"items": [],
"collapsed": true
},
{
"text": "深圳",
"items": [
{
"text": "20240916-深圳湾-单骑",
"link": "/摄影/深圳/20240916-深圳湾-单骑"
},
{
"text": "20240901-南山公园&蛇口",
"link": "/摄影/深圳/20240901-南山公园&蛇口"
},
{
"text": "20241002-环南山区&欢乐港湾",
"link": "/摄影/深圳/20241002-环南山区&欢乐港湾"
}
],
"collapsed": true
}
],
"link": "/摄影"
}
],
"search": {
"provider": "local"
},
"lastUpdated": {
"text": "最近更新于",
"formatOptions": {
"dateStyle": "full",
"timeStyle": "medium"
}
},
"footer": {
"message": "Released under the MIT License.",
"copyright": "Copyright © 2024 CcNut0519"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "招式套路/api-examples.md",
"filePath": "招式套路/api-examples.md",
"lastUpdated": 1734407329000
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.