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
{
"i18nRouting": true,
"logo": "/public/favicon.ico",
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/nosqlnull/chatgpt-midjourney-web-sparkai"
}
],
"search": {
"provider": "local",
"options": {
"locales": {
"root": {
"translations": {
"button": {
"buttonText": "搜索",
"buttonAriaLabel": "搜索"
},
"modal": {
"noResultsText": "无法找到相关结果",
"resetButtonTitle": "清除查询条件",
"footer": {
"selectText": "选择",
"navigateText": "切换",
"closeText": "关闭"
}
}
}
},
"en": {
"translations": {
"button": {
"buttonText": "Search",
"buttonAriaLabel": "Search"
},
"modal": {
"noResultsText": "No results found",
"resetButtonTitle": "Reset search",
"footer": {
"selectText": "to select",
"navigateText": "to navigate",
"closeText": "to close"
}
}
}
}
}
}
},
"nav": [
{
"text": "🏠文档首页",
"link": "/"
},
{
"text": "🖥️项目介绍",
"items": [
{
"text": "📗项目介绍",
"link": "/docs/guide/"
},
{
"text": "🧠公益免费版",
"link": "/docs/SparkAi-AiWeb"
},
{
"text": "🛒商业版系统",
"link": "https://bx5gkpqv57j.feishu.cn/docx/EOWUdQ04no9PoBxyp6Ecg3AAnhf"
}
]
},
{
"text": "🛒系统授权",
"link": "https://bx5gkpqv57j.feishu.cn/docx/EOWUdQ04no9PoBxyp6Ecg3AAnhf"
},
{
"text": "📄安装部署",
"items": [
{
"text": "💫部署准备",
"link": "/deploy/baota/prepare"
},
{
"text": "🎯部署教程",
"link": "/deploy/baota/process"
},
{
"text": "🗂️商业版部署文档",
"link": "https://lvgowblkkt8.feishu.cn/wiki/KZkVw7waxit7biktXhHcsaYanAc"
}
]
},
{
"text": "📝更新日志",
"link": "/log/"
},
{
"text": "🌏官方网站",
"items": [
{
"text": "🤖系统官网",
"link": "https://www.sparkaigf.com"
},
{
"text": "🎉系统演示",
"link": "https://ai.sparkaigf.com"
},
{
"text": "🔎推荐API",
"link": "https://api.oneabc.org"
}
]
},
{
"text": "💬联系我们",
"items": [
{
"text": "📢联系方式",
"link": "/docs/license"
}
]
}
],
"sidebar": {
"/log/": [
{
"text": "更新日志",
"items": [
{
"text": "📑V - 6.8",
"link": "/log/v6.8"
},
{
"text": "📑V - 6.7",
"link": "/log/v6.7"
},
{
"text": "📑V - 6.6",
"link": "/log/v6.6"
},
{
"text": "📑V - 6.5",
"link": "/log/v6.5"
},
{
"text": "📑V - 6.4",
"link": "/log/v6.4"
},
{
"text": "📑V - 6.3",
"link": "/log/v6.3"
},
{
"text": "📑V - 6.2",
"link": "/log/v6.2"
},
{
"text": "📑V - 6.1",
"link": "/log/v6.1"
},
{
"text": "📑V - 6.0",
"link": "/log/v6"
},
{
"text": "📑更早版本",
"link": "/log/history"
}
]
}
],
"/docs/": [
{
"text": "🎯项目文档",
"items": [
{
"text": "📖项目介绍",
"link": "/docs/guide"
},
{
"text": "📚免费版本",
"link": "/docs/SparkAi-AiWeb"
},
{
"text": "🛍️商业版本",
"link": "/docs/license"
},
{
"text": "🤖部署方式",
"link": "/deploy/baota/process"
},
{
"text": "💫部署准备",
"link": "/deploy/baota/prepare"
},
{
"text": "🔄系统更新",
"link": "/deploy/baota/upgrade"
},
{
"text": "👥成为代理",
"link": "/pro/agent"
},
{
"text": "🔍更多文档说明（待补充...）",
"link": "/"
}
]
}
],
"/deploy/": [
{
"text": "🎉部署方式",
"items": [
{
"text": "📖项目介绍",
"link": "/docs/guide"
},
{
"text": "📚免费版本",
"link": "/docs/SparkAi-AiWeb"
},
{
"text": "🛍️商业版本",
"link": "/docs/license"
},
{
"text": "🤖部署方式",
"link": "/deploy/baota/process"
},
{
"text": "💫部署准备",
"link": "/deploy/baota/prepare"
},
{
"text": "🔄系统更新",
"link": "/deploy/baota/upgrade"
},
{
"text": "👥成为代理",
"link": "/pro/agent"
},
{
"text": "🔍更多文档说明（待补充...）",
"link": "/"
}
]
}
],
"/pro/": [
{
"text": "🛍️商业授权",
"items": [
{
"text": "📖项目介绍",
"link": "/docs/guide"
},
{
"text": "📚免费版本",
"link": "/docs/SparkAi-AiWeb"
},
{
"text": "🛒商业版本",
"link": "/docs/license"
},
{
"text": "🤖部署方式",
"link": "/deploy/baota/process"
},
{
"text": "💫部署准备",
"link": "/deploy/baota/prepare"
},
{
"text": "🔄系统更新",
"link": "/deploy/baota/upgrade"
},
{
"text": "👥成为代理",
"link": "/pro/agent"
},
{
"text": "🔍更多文档说明（待补充...）",
"link": "/"
}
]
}
]
},
"footer": {
"message": "Released under the APSL License.",
"copyright": "Copyright © 2023-2025 SparkAi"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api.md",
"filePath": "api.md"
}Page Frontmatter
{
"outline": "deep"
}