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
{
"nav": [
{
"text": "Home",
"link": "/"
},
{
"text": "System Updates",
"link": "/admin/updates/2026.md"
}
],
"sidebar": {
"/quick-start/": [
{
"text": "Quick Start",
"items": [
{
"text": "Introduction",
"link": "/quick-start/"
},
{
"text": "Markdown Examples",
"link": "/quick-start/markdown-examples"
}
]
}
],
"/admin/": [
{
"text": "Administrator Guide",
"items": [
{
"text": "Home",
"link": "/"
},
{
"text": "Admin QuickStart Guide",
"link": "/admin/quick-start"
},
{
"text": "Admin User Guide",
"collapsed": true,
"items": [
{
"text": "Configuration",
"link": "/admin/userguide/config"
},
{
"text": "Dashboard",
"link": "/admin/userguide/dashboard"
},
{
"text": "Take Minutes",
"link": "/admin/userguide/take-minutes"
},
{
"text": "Minutes Approval/Sign Off",
"link": "/admin/userguide/minutes-sign-off"
},
{
"text": "Meeting Pack Build",
"link": "/admin/userguide/meeting-pack-build-times"
},
{
"text": "Bulk Extract",
"link": "/admin/userguide/settings-bulk-extract"
},
{
"text": "Portal Settings",
"link": "/admin/userguide/settings"
}
]
},
{
"text": "Discovering OCH Videos",
"collapsed": true,
"items": [
{
"text": "Overview",
"link": "/admin/discover/index"
},
{
"text": "Dashboard",
"link": "/admin/discover/dashboard"
},
{
"text": "My Profile",
"link": "/admin/discover/my-profile"
},
{
"text": "Members",
"link": "/admin/discover/members"
},
{
"text": "Discussions",
"link": "/admin/discover/discussions"
},
{
"text": "Meetings",
"link": "/admin/discover/meetings",
"items": [
{
"text": "Meeting Types",
"link": "/admin/discover/meetings#meetings-meeting-types"
},
{
"text": "Building Agendas",
"link": "/admin/discover/meetings#meetings-agenda-builder"
},
{
"text": "Minute Taking",
"link": "/admin/discover/meetings#meetings-meeting-attendees-invites"
}
]
},
{
"text": "Actions",
"link": "/admin/discover/actions"
},
{
"text": "Decisions",
"link": "/admin/discover/decisions"
},
{
"text": "Documents",
"link": "/admin/discover/documents"
},
{
"text": "Links",
"link": "/admin/discover/links"
},
{
"text": "Settings",
"link": "/admin/discover/settings"
},
{
"text": "Activity Log",
"link": "/admin/discover/activity-log"
},
{
"text": "Cleaning Minutes",
"link": "/admin/discover/cleaning-minutes"
},
{
"text": "Signing Off Minutes",
"link": "/admin/discover/approving-minutes"
},
{
"text": "Portal Customisation",
"link": "/admin/discover/customising-colours-and-images"
},
{
"text": "Reports",
"link": "/admin/discover/reports"
},
{
"text": "Billing",
"link": "/admin/discover/billing"
}
]
},
{
"text": "Roles",
"collapsed": true,
"items": [
{
"text": "Overview",
"link": "/admin/roles"
},
{
"text": "Admin",
"link": "/admin/roles/admin"
},
{
"text": "Chair",
"link": "/admin/roles/chair"
},
{
"text": "Co-Chair",
"link": "/admin/roles/cochair"
},
{
"text": "Deputy Chair",
"link": "/admin/roles/deputychair"
},
{
"text": "Secretary",
"link": "/admin/roles/secretary"
},
{
"text": "Treasurer",
"link": "/admin/roles/treasurer"
},
{
"text": "President",
"link": "/admin/roles/president"
},
{
"text": "Vice President",
"link": "/admin/roles/vicepresident"
},
{
"text": "CEO",
"link": "/admin/roles/ceo"
},
{
"text": "Executive Officer",
"link": "/admin/roles/executiveofficer"
},
{
"text": "Public Officer",
"link": "/admin/roles/publicofficer"
},
{
"text": "Trustee",
"link": "/admin/roles/trustee"
},
{
"text": "Auditor",
"link": "/admin/roles/auditor"
},
{
"text": "Billing Contact",
"link": "/admin/roles/billingcontact"
},
{
"text": "Staff",
"link": "/admin/roles/staff"
},
{
"text": "Member",
"link": "/admin/roles/member"
},
{
"text": "Ordinary Member",
"link": "/admin/roles/ordinarymember"
},
{
"text": "Guest",
"link": "/admin/roles/guest"
},
{
"text": "Ex-Officio",
"link": "/admin/roles/exofficio"
},
{
"text": "Other",
"link": "/admin/roles/other"
},
{
"text": "Multiple Roles",
"link": "/admin/roles/multiple"
}
]
},
{
"text": "Other",
"collapsed": true,
"items": [
{
"text": "F.A.Q",
"link": "/admin/other/index"
},
{
"text": "Troubleshooting",
"link": "/admin/other/troubleshooting"
},
{
"text": "Meeting Pack Exclude Docs",
"link": "/admin/other/hide-documents-meeting-pack"
},
{
"text": "Multi-Factor Auth",
"link": "/admin/userguide/mfa"
}
]
},
{
"text": "General Member Guide",
"link": "/general/quick-start"
}
]
}
],
"/": [
{
"text": "Member Guide",
"items": [
{
"text": "Home",
"link": "/"
},
{
"text": "Member Quick Start Guide",
"link": "/general/quick-start"
},
{
"text": "Getting Oriented",
"link": "/general/getting-oriented"
},
{
"text": "Dashboard",
"link": "/general/dashboard/index"
},
{
"text": "Multi Factor Auth",
"link": "/general/mfa"
},
{
"text": "Profile/My Details",
"link": "/general/my-details/index"
},
{
"text": "Members",
"link": "/general/members/index"
},
{
"text": "Meetings",
"link": "/general/meetings/index"
},
{
"text": "Actions",
"link": "/general/actions/index"
},
{
"text": "Links",
"link": "/general/links/index"
},
{
"text": "Discussions",
"link": "/general/discussions/index"
},
{
"text": "Documents",
"link": "/general/documents/index"
},
{
"text": "Password Troubleshooting",
"link": "/general/passwords"
},
{
"text": "Activation Troubleshooting",
"link": "/general/activation-troubleshooting"
},
{
"text": "Decisions",
"link": "/general/decisions/index"
}
]
}
]
},
"footer": {
"message": "",
"copyright": "© 2026 Our Cat Herder"
},
"search": {
"provider": "local"
},
"docFooter": {
"prev": false,
"next": false
}
}Page Data
{
"title": "API Examples",
"description": "",
"frontmatter": {
"title": "API Examples",
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md",
"lastUpdated": 1772774684000
}Page Frontmatter
{
"title": "API Examples",
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.