Appearance
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
{
"alert": false,
"autometa": false,
"collections": {
"post": {
"frontmatter": {
"collection": "post",
"contributors": false,
"backLink": {
"text": "<- Back to blog",
"link": "/blog"
},
"aside": false,
"sidebar": false,
"prev": false,
"next": false,
"editLink": false
},
"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"currentColor\" class=\"w-6 h-6\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M7.5 8.25h9m-9 3H12m-9.75 1.51c0 1.6 1.123 2.994 2.707 3.227 1.129.166 2.27.293 3.423.379.35.026.67.21.865.501L12 21l2.755-4.133a1.14 1.14 0 0 1 .865-.501 48.172 48.172 0 0 0 3.423-.379c1.584-.233 2.707-1.626 2.707-3.228V6.741c0-1.602-1.123-2.995-2.707-3.228A48.394 48.394 0 0 0 12 3c-2.392 0-4.744.175-7.043.513C3.373 3.746 2.25 5.14 2.25 6.741v6.018Z\"/></svg>",
"iconLink": "/blog",
"patterns": [
"blog/**/*.md"
]
},
"guide": {
"frontmatter": {
"collection": "guide"
},
"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"currentColor\" class=\"w-6 h-6\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M4.26 10.147a60.438 60.438 0 0 0-.491 6.347A48.62 48.62 0 0 1 12 20.904a48.62 48.62 0 0 1 8.232-4.41 60.46 60.46 0 0 0-.491-6.347m-15.482 0a50.636 50.636 0 0 0-2.658-.813A59.906 59.906 0 0 1 12 3.493a59.903 59.903 0 0 1 10.399 5.84c-.896.248-1.783.52-2.658.814m-15.482 0A50.717 50.717 0 0 1 12 13.489a50.702 50.702 0 0 1 7.74-3.342M6.75 15a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm0 0v-3.675A55.378 55.378 0 0 1 12 8.443m-7.007 11.55A5.981 5.981 0 0 0 6.75 15.75v-1.5\" /></svg>",
"iconLink": "/guides",
"patterns": [
"guides/**/*.md"
]
},
"writing": {
"frontmatter": {
"collection": "writing",
"contributors": false,
"backLink": {
"text": "<- Back to writing",
"link": "/writing"
},
"aside": false,
"sidebar": false,
"prev": false,
"next": false,
"editLink": false
},
"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"currentColor\" class=\"w-6 h-6\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M7.5 8.25h9m-9 3H12m-9.75 1.51c0 1.6 1.123 2.994 2.707 3.227 1.129.166 2.27.293 3.423.379.35.026.67.21.865.501L12 21l2.755-4.133a1.14 1.14 0 0 1 .865-.501 48.172 48.172 0 0 0 3.423-.379c1.584-.233 2.707-1.626 2.707-3.228V6.741c0-1.602-1.123-2.995-2.707-3.228A48.394 48.394 0 0 0 12 3c-2.392 0-4.744.175-7.043.513C3.373 3.746 2.25 5.14 2.25 6.741v6.018Z\"/></svg>",
"iconLink": "/writing",
"patterns": [
"writing/**/*.md"
]
},
"development": {
"frontmatter": {
"collection": "development",
"contributors": false,
"backLink": {
"text": "<- Back to development blog",
"link": "/development"
},
"aside": false,
"sidebar": false,
"prev": false,
"next": false,
"editLink": false
},
"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"currentColor\" class=\"w-6 h-6\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M7.5 8.25h9m-9 3H12m-9.75 1.51c0 1.6 1.123 2.994 2.707 3.227 1.129.166 2.27.293 3.423.379.35.026.67.21.865.501L12 21l2.755-4.133a1.14 1.14 0 0 1 .865-.501 48.172 48.172 0 0 0 3.423-.379c1.584-.233 2.707-1.626 2.707-3.228V6.741c0-1.602-1.123-2.995-2.707-3.228A48.394 48.394 0 0 0 12 3c-2.392 0-4.744.175-7.043.513C3.373 3.746 2.25 5.14 2.25 6.741v6.018Z\"/></svg>",
"iconLink": "/development",
"patterns": [
"development/**/*.md"
]
},
"crafting": {
"frontmatter": {
"collection": "crafting",
"contributors": false,
"backLink": {
"text": "<- Back to crafting blog",
"link": "/crafting"
},
"aside": false,
"sidebar": false,
"prev": false,
"next": false,
"editLink": false
},
"icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"currentColor\" class=\"w-6 h-6\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" d=\"M7.5 8.25h9m-9 3H12m-9.75 1.51c0 1.6 1.123 2.994 2.707 3.227 1.129.166 2.27.293 3.423.379.35.026.67.21.865.501L12 21l2.755-4.133a1.14 1.14 0 0 1 .865-.501 48.172 48.172 0 0 0 3.423-.379c1.584-.233 2.707-1.626 2.707-3.228V6.741c0-1.602-1.123-2.995-2.707-3.228A48.394 48.394 0 0 0 12 3c-2.392 0-4.744.175-7.043.513C3.373 3.746 2.25 5.14 2.25 6.741v6.018Z\"/></svg>",
"iconLink": "/crafting",
"patterns": [
"crafting/**/*.md"
]
}
},
"containers": {
"brand": {
"defaultTitle": "BRAND"
},
"box": {},
"box-blue": {},
"box-brand": {},
"box-green": {},
"box-red": {},
"box-yellow": {},
"caption": {},
"card": {},
"center": {},
"half": {},
"highlight": {},
"left": {},
"right": {},
"success": {
"defaultTitle": "SUCCESS"
},
"third": {},
"thumbnail": {}
},
"contributors": {
"merge": "name",
"debotify": true,
"exclude": [],
"include": []
},
"internalDomain": [],
"internalDomains": [],
"ga": false,
"hubspot": false,
"jobs": false,
"lastUpdated": {
"text": "Updated",
"formatOptions": {
"dateStyle": "timeago"
}
},
"layouts": {},
"multiVersionBuild": false,
"nav": [
{
"text": "Home",
"link": "/"
},
{
"text": "Writing",
"link": "/writing"
},
{
"text": "Dev",
"link": "/development"
},
{
"text": "Crafting",
"link": "/crafting"
}
],
"sidebar": {},
"sidebarEnder": false,
"sponsors": false,
"tags": {},
"team": [],
"versions": {
"dev": "aff97",
"edge": "HEAD",
"stable": "HEAD"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep",
"date": 1744061582000,
"authors": [],
"tags": [],
"head": []
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md",
"lastUpdated": 1744061582000,
"timestamp": 1744061582000,
"datetime": "2025-04-07T21:33:02.000Z",
"contributors": [
{
"commits": 1,
"email": "[email protected]",
"name": "Allison Betancourt",
"avatar": "https://gravatar.com/avatar/22a9e06ef2d3995db842641b586a0fb2",
"maintainer": false,
"links": []
}
]
}Page Frontmatter
{
"outline": "deep",
"date": 1744061582000,
"authors": [],
"tags": [],
"head": []
}More
Check out the documentation for the full list of runtime APIs.