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
{
"outlineTitle": "目录",
"outline": [
2,
6
],
"logo": "/logo.png",
"nav": [
{
"text": "首页",
"link": "/"
},
{
"text": "日语",
"items": [
{
"text": "日语知识体系",
"link": "/japanese/zstx/前言"
},
{
"text": "日语学习资源",
"link": "/japanese/xgzl/riyuziyuan"
}
]
},
{
"text": "韩语",
"link": "/language/korean/韩语"
},
{
"text": "俄语",
"items": [
{
"text": "俄语语法",
"link": "/russian/russiangrammer/西里尔字母"
},
{
"text": "俄语学习资源",
"link": "/"
}
]
},
{
"text": "西语",
"link": "/"
},
{
"text": "法语",
"link": "/"
},
{
"text": "德语",
"link": "/"
}
],
"sidebar": {
"/japanese/zstx": [
{
"text": "日语总述",
"collapsed": false,
"items": [
{
"text": "前言",
"link": "/japanese/zstx/前言"
},
{
"text": "特征",
"link": "/japanese/zstx/特征"
},
{
"text": "历史",
"link": "/japanese/zstx/历史"
},
{
"text": "系属分类",
"link": "/japanese/zstx/系属分类"
}
]
},
{
"text": "日语读写",
"collapsed": false,
"items": [
{
"text": "书写系统",
"link": "/japanese/zstx/书写系统"
},
{
"text": "书写示范",
"link": "/japanese/zstx/书写示范"
},
{
"text": "声调",
"link": "/japanese/zstx/声调"
}
]
},
{
"text": "日语语法",
"collapsed": false,
"items": [
{
"text": "句子结构",
"link": "/japanese/zstx/句子结构"
},
{
"text": "句子成分",
"link": "/japanese/zstx/句子成分"
},
{
"text": "词类",
"link": "/japanese/zstx/词类"
},
{
"text": "名词的格",
"link": "/japanese/zstx/名词的格"
},
{
"text": "活用及其种类",
"link": "/japanese/zstx/活用及其种类"
}
]
},
{
"text": "日语词汇",
"collapsed": false,
"items": [
{
"text": "词汇的种类",
"link": "/japanese/zstx/词汇的种类"
},
{
"text": "拟声和拟态词",
"link": "/japanese/zstx/拟声和拟态词"
},
{
"text": "敬语",
"link": "/japanese/zstx/敬语"
},
{
"text": "方言",
"link": "/japanese/zstx/方言"
}
]
},
{
"text": "日语句法",
"collapsed": false,
"items": [
{
"text": "句子句素",
"link": "/japanese/zstx/句子句素"
},
{
"text": "句子成分1",
"link": "/japanese/zstx/句子成分1"
},
{
"text": "陈述方式",
"link": "/japanese/zstx/陈述方式"
},
{
"text": "句子分类",
"link": "/japanese/zstx/句子分类"
}
]
},
{
"text": "日语篇章法",
"collapsed": false,
"items": [
{
"text": "日语语段",
"link": "/japanese/zstx/日语语段"
},
{
"text": "日语文章结构",
"link": "/japanese/zstx/日语文章结构"
},
{
"text": "日语文章体裁",
"link": "/japanese/zstx/日语文章体裁"
}
]
}
],
"/japanese/": [
{
"text": "日语学习资源",
"items": [
{
"text": "日语博主推荐",
"link": "/japanese/xgzl/riyuziyuan"
},
{
"text": "日语网站推荐",
"link": "/japanese/xgzl/ceshi"
},
{
"text": "日语工具推荐",
"link": "/config/four"
}
]
}
],
"/russian/": [
{
"text": "俄语简介",
"collapsed": true,
"items": [
{
"text": "西里尔字母",
"link": "/russian/russiangrammer/西里尔字母"
},
{
"text": "国际音标(IPA)",
"link": "/russian/russiangrammer/国际音标(IPA)"
},
{
"text": "俄语发音",
"link": "/russian/russiangrammer/俄语发音"
},
{
"text": "俄语正字法",
"link": "/russian/russiangrammer/俄语正字法"
},
{
"text": "词语划分",
"link": "/russian/russiangrammer/词语划分"
},
{
"text": "标点符号",
"link": "/russian/russiangrammer/标点符号"
}
]
},
{
"text": "俄语名词",
"collapsed": true,
"items": [
{
"text": "名词构词法",
"link": "/russian/russiangrammer/名词构词法"
},
{
"text": "名词词性",
"link": "/russian/russiangrammer/名词词性"
},
{
"text": "名词变格",
"link": "/russian/russiangrammer/名词变格"
},
{
"text": "格的用法",
"link": "/russian/russiangrammer/格的用法"
},
{
"text": "指小指大名词",
"link": "/russian/russiangrammer/指小指大名词"
}
]
},
{
"items": [
{
"text": "俄语代词",
"link": "/russian/russiangrammer/俄语代词"
}
]
},
{
"text": "俄语形容词",
"collapsed": true,
"items": [
{
"text": "形容词简介",
"link": "/russian/russiangrammer/形容词简介"
},
{
"text": "形容词长尾形式",
"link": "/russian/russiangrammer/形容词长尾形式"
},
{
"text": "形容词短尾形式",
"link": "/russian/russiangrammer/形容词短尾形式"
},
{
"text": "形容词比较级",
"link": "/russian/russiangrammer/形容词比较级"
},
{
"text": "形容词最高级",
"link": "/russian/russiangrammer/形容词最高级"
}
]
},
{
"text": "数词",
"collapsed": true,
"items": [
{
"text": "基数词",
"link": "/russian/russiangrammer/基数词"
},
{
"text": "集合数词",
"link": "/russian/russiangrammer/集合数词"
},
{
"text": "不定数词",
"link": "/russian/russiangrammer/不定数词"
},
{
"text": "序数词",
"link": "/russian/russiangrammer/序数词"
},
{
"text": "数词的特殊功能",
"link": "/russian/russiangrammer/数词的特殊功能"
}
]
},
{
"text": "动词",
"collapsed": true,
"items": [
{
"text": "动词变位",
"link": "/russian/russiangrammer/动词变位"
},
{
"text": "动词的体",
"link": "/russian/russiangrammer/动词的体"
},
{
"text": "反身动词",
"link": "/russian/russiangrammer/反身动词"
},
{
"text": "动词非人称结构",
"link": "/russian/russiangrammer/动词非人称结构"
},
{
"text": "动词被动语态",
"link": "/russian/russiangrammer/动词被动语态"
},
{
"text": "动词条件式和虚拟式",
"link": "/russian/russiangrammer/动词条件式和虚拟式"
},
{
"text": "表示义务、必要性、可能性或潜力的结构",
"link": "/russian/russiangrammer/表示义务、必要性、可能性或潜力的结构"
},
{
"text": "运动动词",
"link": "/russian/russiangrammer/运动动词"
},
{
"text": "分词",
"link": "/russian/russiangrammer/分词"
},
{
"text": "动名词",
"link": "/russian/russiangrammer/动名词"
}
]
},
{
"items": [
{
"text": "俄语副词",
"link": "/russian/russiangrammer/俄语副词"
}
]
},
{
"text": "俄语介词",
"collapsed": true,
"items": [
{
"text": "介词总述",
"link": "/russian/russiangrammer/介词总述"
},
{
"text": "介词的类型",
"link": "/russian/russiangrammer/介词的类型"
},
{
"text": "介词用法",
"link": "/russian/russiangrammer/介词用法"
}
]
},
{
"text": "俄语连词",
"collapsed": true,
"items": [
{
"text": "连词总述",
"link": "/russian/russiangrammer/连词总述"
},
{
"text": "并列连词",
"link": "/russian/russiangrammer/并列连词"
},
{
"text": "从属连词",
"link": "/russian/russiangrammer/从属连词"
}
]
},
{
"items": [
{
"text": "俄语语气词",
"link": "/russian/russiangrammer/俄语语气词"
}
]
},
{
"items": [
{
"text": "俄语词序",
"link": "/russian/russiangrammer/俄语词序"
}
]
},
{
"items": [
{
"text": "附录",
"link": "/russian/russiangrammer/附录"
}
]
},
{
"items": [
{
"text": "术语表",
"link": "/russian/russiangrammer/术语表"
}
]
}
]
},
"footer": {
"message": "created by xixifusi",
"copyright": "Copyright © 2024"
},
"search": {
"provider": "local",
"options": {
"translations": {
"button": {
"buttonText": "搜索知识点",
"buttonAriaLabel": "搜索知识点"
},
"modal": {
"noResultsText": "无法找到相关结果",
"resetButtonTitle": "清除查询条件",
"footer": {
"selectText": "选择",
"navigateText": "切换"
}
}
}
}
},
"socialLinks": [
{
"icon": {
"svg": "<svg t=\"1727676702247\" class=\"icon\" viewBox=\"0 0 1129 1024\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" p-id=\"4281\" width=\"200\" height=\"200\"><path d=\"M234.909 9.656a80.468 80.468 0 0 1 68.398 0 167.374 167.374 0 0 1 41.843 30.578l160.937 140.82h115.07l160.936-140.82a168.983 168.983 0 0 1 41.843-30.578A80.468 80.468 0 0 1 930.96 76.445a80.468 80.468 0 0 1-17.703 53.914 449.818 449.818 0 0 1-35.406 32.187 232.553 232.553 0 0 1-22.531 18.508h100.585a170.593 170.593 0 0 1 118.289 53.109 171.397 171.397 0 0 1 53.914 118.288v462.693a325.897 325.897 0 0 1-4.024 70.007 178.64 178.64 0 0 1-80.468 112.656 173.007 173.007 0 0 1-92.539 25.75h-738.7a341.186 341.186 0 0 1-72.421-4.024A177.835 177.835 0 0 1 28.91 939.065a172.202 172.202 0 0 1-27.36-92.539V388.662a360.498 360.498 0 0 1 0-66.789A177.03 177.03 0 0 1 162.487 178.64h105.414c-16.899-12.07-31.383-26.555-46.672-39.43a80.468 80.468 0 0 1-25.75-65.984 80.468 80.468 0 0 1 39.43-63.57M216.4 321.873a80.468 80.468 0 0 0-63.57 57.937 108.632 108.632 0 0 0 0 30.578v380.615a80.468 80.468 0 0 0 55.523 80.469 106.218 106.218 0 0 0 34.601 5.632h654.208a80.468 80.468 0 0 0 76.444-47.476 112.656 112.656 0 0 0 8.047-53.109v-354.06a135.187 135.187 0 0 0 0-38.625 80.468 80.468 0 0 0-52.304-54.719 129.554 129.554 0 0 0-49.89-7.242H254.22a268.764 268.764 0 0 0-37.82 0z m0 0\" fill=\"#20B0E3\" p-id=\"4282\"></path><path d=\"M348.369 447.404a80.468 80.468 0 0 1 55.523 18.507 80.468 80.468 0 0 1 28.164 59.547v80.468a80.468 80.468 0 0 1-16.094 51.5 80.468 80.468 0 0 1-131.968-9.656 104.609 104.609 0 0 1-10.46-54.719v-80.468a80.468 80.468 0 0 1 70.007-67.593z m416.02 0a80.468 80.468 0 0 1 86.102 75.64v80.468a94.148 94.148 0 0 1-12.07 53.11 80.468 80.468 0 0 1-132.773 0 95.757 95.757 0 0 1-12.875-57.133V519.02a80.468 80.468 0 0 1 70.007-70.812z m0 0\" fill=\"#20B0E3\" p-id=\"4283\"></path></svg>"
},
"link": "https://www.bilibili.com/"
}
]
}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.