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
{
"search": {
"provider": "local",
"options": {
"locales": {
"zh": {
"translations": {
"button": {
"buttonText": "搜索文档",
"buttonAriaLabel": "搜索文档"
},
"modal": {
"noResultsText": "无法搜索到结果",
"resetButtonTitle": "清除查询条件",
"footer": {
"selectText": "选择",
"navigateText": "切换"
}
}
}
}
}
}
},
"logo": {
"src": "/vitepress-logo-mini.svg",
"width": 24,
"height": 24
},
"carbonAds": {
"code": "CEBDT27Y",
"placement": "vuejsorg"
},
"nav": [
{
"text": "首页",
"link": "/"
},
{
"text": "1.0.0",
"items": [
{
"text": "更新日志",
"link": "https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md"
}
]
}
],
"sidebar": [
{
"text": "面试",
"collapsed": true,
"link": "/guide/offer/1.md"
},
{
"text": "基础",
"collapsed": false,
"items": [
{
"text": "javascript",
"collapsed": true,
"items": [
{
"text": "设计模式",
"link": "/guide/web/javascript/设计模式"
},
{
"text": "深浅克隆",
"link": "/guide/web/javascript/clone"
},
{
"text": "数组（Array）",
"link": "/guide/web/javascript/array"
},
{
"text": "对象（Object）",
"link": "/guide/web/javascript/object"
},
{
"text": "实用技巧",
"link": "/guide/web/javascript/js"
}
]
},
{
"text": "git",
"link": "/guide/web/git"
},
{
"text": "axios",
"link": "/guide/web/axios"
},
{
"text": "H5",
"link": "/guide/web/h5"
},
{
"text": "页面访问统计",
"link": "/guide/web/pagecount"
},
{
"text": "文件上传（切片）",
"link": "/guide/web/upload"
}
]
},
{
"text": "前端框架",
"collapsed": true,
"items": [
{
"text": "React",
"collapsed": false,
"items": [
{
"text": "项目搭建",
"link": "/guide/framework/react/create"
},
{
"text": "API",
"link": "/guide/framework/react/hooks"
},
{
"text": "持久化存储方案",
"link": "/guide/framework/react/storage"
},
{
"text": "主题切换",
"link": "/guide/framework/react/themes"
},
{
"text": "优化",
"link": "/guide/framework/react/性能优化"
}
]
},
{
"text": "Vue",
"collapsed": false,
"items": [
{
"text": "项目搭建",
"link": "/guide/framework/vue/create"
},
{
"text": "API",
"link": "/guide/framework/vue/api"
}
]
}
]
},
{
"text": "前端组件库",
"collapsed": true,
"items": [
{
"text": "React组件库搭建",
"link": "/guide/ui/dumi"
},
{
"text": "Antd",
"link": "/guide/ui/antd"
},
{
"text": "Element",
"link": "/guide/ui/element"
}
]
},
{
"text": "打包构建",
"collapsed": true,
"items": [
{
"text": "Webpack",
"link": "/guide/build/webpack"
},
{
"text": "Rollup",
"link": "/guide/build/rollup"
},
{
"text": "Vite",
"link": "/guide/build/vite"
}
]
},
{
"text": "性能优化",
"collapsed": true,
"items": [
{
"text": "1",
"link": "/guide/optimize/1"
}
]
},
{
"text": "Node",
"collapsed": true,
"items": [
{
"text": "Node.js",
"link": "/guide/node/api"
},
{
"text": "Koa.js",
"collapsed": true,
"items": [
{
"text": "项目搭建",
"link": "/guide/node/koa/koa-init"
},
{
"text": "数据库连接",
"link": "/guide/node/koa/数据库连接"
},
{
"text": "文件上传",
"link": "/guide/node/koa/文件上传"
},
{
"text": "多进程",
"link": "/guide/nodee/koa/多进程"
},
{
"text": "打包",
"link": "/guide/node/koa/服务端打包"
}
]
},
{
"text": "Egg.js",
"link": "/guide/node/egg/egg-init"
},
{
"text": "Express.js",
"link": "/guide/node/express/express-init"
},
{
"text": "Nest.js",
"link": "/guide/node/nest/nest-init"
}
]
},
{
"text": "数据库",
"collapsed": true,
"items": [
{
"text": "数据库对比",
"link": "/guide/db/database"
},
{
"text": "MongoDB",
"link": "/guide/db/mongodb"
},
{
"text": "MySQL",
"link": "/guide/db/mysql"
},
{
"text": "Redis",
"link": "/guide/db/redis"
}
]
},
{
"text": "云服务器",
"collapsed": true,
"items": [
{
"text": "CentOS",
"link": "/guide/server/centos"
},
{
"text": "uBuntu",
"link": "/guide/server/ubuntu"
}
]
},
{
"text": "Bugs",
"link": "/bug/"
}
],
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/533wusaisai/wss"
}
],
"footer": {
"message": "Released under the <a href=\"https://github.com/vuejs/vitepress/blob/main/LICENSE\">MIT License</a>.",
"copyright": "Copyright © 2024-present <a href=\"https://github.com/533wusaisai/wss\">wusaisai</a>"
},
"docFooter": {
"prev": "上一页",
"next": "下一页"
},
"lastUpdated": {
"text": "最后更新于",
"formatOptions": {
"dateStyle": "short",
"timeStyle": "medium"
}
},
"outline": {
"label": "页面导航"
},
"editLink": {
"pattern": "https://github.com/vuejs/vitepress/edit/main/docs/:path",
"text": "在 GitHub 上编辑此页面"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md",
"lastUpdated": 1724076483000
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.