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
{
"logo": "/images/logo.png",
"footer": {
"message": "Released under the <a href=\"https://github.com/samjuk/docs.sdj.pw/blob/master/LICENSE\">MIT License</a>.",
"copyright": "Copyright © 2024-present <a href=\"https://github.com/samjuk\">SamJUK</a>"
},
"editLink": {
"pattern": "https://github.com/samjuk/docs.sdj.pw/edit/master/src/:path",
"text": "Edit this page on GitHub"
},
"historyLink": {
"pattern": "https://github.com/samjuk/docs.sdj.pw/commits/master/src/:path",
"text": "View History"
},
"search": {
"provider": "local"
},
"nav": [
{
"text": "Home",
"link": "/"
},
{
"text": "About Me",
"link": "https://www.sdj.pw/about/"
},
{
"text": "Blog",
"link": "https://www.sdj.pw/"
}
],
"sidebar": [
{
"text": "General",
"collapsed": true,
"items": [
{
"text": "Github",
"collapsed": true,
"items": [
{
"text": "Actions - Standard Streams",
"link": "/general/github/actions/steps-missing-standard-streams"
},
{
"text": "Actions - SSH Config",
"link": "/general/github/actions/ssh-config"
},
{
"text": "Artifact Cleanup",
"link": "/general/github/cleanup-artifacts"
},
{
"text": "Environment Cleanup",
"link": "/general/github/cleanup-environments"
},
{
"text": "Dependabot",
"link": "/general/github/dependabot"
}
]
},
{
"text": "Bitbucket",
"collapsed": true,
"items": [
{
"text": "Renovate",
"link": "/general/bitbucket/renovate-mend"
}
]
},
{
"text": "Block Tor Exit Routes",
"link": "/general/tor-block-exit-routes"
},
{
"text": "CSP Reporting",
"link": "/general/csp-reporting"
},
{
"text": "Powerline10k",
"link": "/general/p10k"
}
]
},
{
"text": "Operations",
"collapsed": true,
"items": [
{
"text": "Ansible",
"collapsed": true,
"items": [
{
"text": "Provisioning",
"link": "operations/ansible/provisioning"
}
]
},
{
"text": "Terraform",
"collapsed": true,
"items": [
{
"text": "Cloudflare",
"link": "operations/terraform/cloudflare"
}
]
}
]
},
{
"text": "Software",
"collapsed": true,
"items": [
{
"text": "NewRelic",
"link": "/software/newrelic"
},
{
"text": "Sentry.io",
"collapsed": true,
"items": [
{
"text": "Self Hosting",
"link": "/software/sentry/self-hosting"
},
{
"text": "Disk Space Cleanup",
"link": "/software/sentry/disk-space-cleanup"
}
]
},
{
"text": "Docker",
"collapsed": true,
"items": [
{
"text": "General",
"link": "/software/docker/docker"
},
{
"text": "Orbstack",
"link": "/software/docker/orbstack"
}
]
},
{
"text": "OpenVPN",
"collapsed": true,
"items": [
{
"text": "OpenVPN Installation",
"link": "/software/openvpn/installation"
},
{
"text": "OpenVPN Split Routing",
"link": "/software/openvpn/split-routing"
},
{
"text": "OpenVPN Static Client IPs",
"link": "/software/openvpn/static-client-ips"
},
{
"text": "OpenVPN Google SSO",
"link": "/software/openvpn/google-sso"
}
]
},
{
"text": "NordVPN",
"collapsed": true,
"items": [
{
"text": "Auto Rotating Connection",
"link": "/software/nordvpn/automatic-rotating"
}
]
},
{
"text": "Varnish",
"collapsed": true,
"items": [
{
"text": "Flushing Varnish",
"link": "/software/varnish/flush"
},
{
"text": "Reloading the VCL",
"link": "/software/varnish/reloading-the-vcl"
},
{
"text": "Debug Cache Performance",
"link": "/software/varnish/debug-cache-performance"
},
{
"text": "403 Header Too Large",
"link": "/software/varnish/403-headers-too-large"
}
]
},
{
"text": "Nginx",
"collapsed": true,
"items": [
{
"text": "Nginx Replace Polyfill.io",
"link": "/software/nginx/replace-polyfill-io"
},
{
"text": "Nginx Rate Limiting",
"link": "/software/nginx/rate-limiting"
},
{
"text": "Nginx X-Robots Disable Indexing",
"link": "/software/nginx/robots.md"
}
]
},
{
"text": "PHP",
"collapsed": true,
"items": [
{
"text": "General",
"link": "/software/php/general"
}
]
},
{
"text": "Composer",
"collapsed": true,
"items": [
{
"text": "Composer Patches",
"link": "/software/composer/patches"
},
{
"text": "Composer Artifacts",
"link": "/software/composer/artifacts"
}
]
},
{
"text": "Curl",
"link": "/software/curl"
}
]
},
{
"text": "Warden",
"collapsed": true,
"items": [
{
"text": "Anonymise DB",
"link": "/warden/anonymise-db"
},
{
"text": "Install PHP-SPX",
"link": "/warden/php-spx"
},
{
"text": "Wordpress Bedrock",
"link": "/warden/wordpress-bedrock"
}
]
},
{
"text": "Python",
"collapsed": true,
"items": [
{
"text": "Multiple Versions",
"link": "/python/multiple-versions"
},
{
"text": "Virtual Environments",
"link": "/python/virtual-environments"
},
{
"text": "Poetry",
"link": "/python/poetry"
}
]
},
{
"text": "Linux",
"collapsed": true,
"items": [
{
"text": "Alerting",
"items": [
{
"text": "Low Disk",
"link": "/linux/email-alerts/disk-space"
},
{
"text": "High Compute",
"link": "/linux/email-alerts/high-compute"
},
{
"text": "Load Graphs",
"link": "/linux/email-alerts/load-graphs"
},
{
"text": "SVC Watchdog",
"link": "/linux/email-alerts/service-watchdog"
}
]
},
{
"text": "Image Optimisation",
"link": "/linux/image-optimisation"
},
{
"text": "Ubuntu",
"link": "/linux/ubuntu"
}
]
},
{
"text": "Magento",
"collapsed": true,
"items": [
{
"text": "General",
"collapsed": true,
"items": [
{
"text": "CLI Scratch file",
"link": "/magento/scratch-file"
}
]
},
{
"text": "Operations",
"collapsed": true,
"items": [
{
"text": "Automatic Updates",
"link": "/magento/auto-updates"
},
{
"text": "Optimise SCD Build Process",
"link": "/magento/optimise-scd-build-process"
},
{
"text": "Managing Media",
"link": "/magento/managing-media"
},
{
"text": "Magepack Javascript Bundling",
"link": "/magento-magepack-javascript-bundling"
},
{
"text": "Critical CSS",
"link": "/magento-critical-css"
},
{
"text": "Cleanup Spam Customer Accounts",
"link": "/magento/spam-account-cleanup"
}
]
},
{
"text": "Development",
"collapsed": true,
"items": [
{
"text": "App/Code",
"link": "/magento/app-code"
}
]
},
{
"text": "Debugging",
"collapsed": true,
"items": [
{
"text": "Identify DB Schema Changes",
"link": "/magento/identify-db-schema-changes"
},
{
"text": "Find noncacheable blocks",
"link": "/magento/non-cacheable-blocks"
}
]
},
{
"text": "Cloud/Commerce",
"collapsed": true,
"items": [
{
"text": "Setting Store Codes",
"link": "/magento/cloud-store-codes"
}
]
},
{
"text": "Security",
"collapsed": true,
"items": [
{
"text": "CosmicSting",
"link": "/magento/cosmicsting"
}
]
}
]
},
{
"text": "AeroCommerce",
"collapsed": true,
"items": [
{
"text": "Tinker",
"link": "/aero-commerce/tinker"
}
]
}
],
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/samjuk"
}
]
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md",
"lastUpdated": 1730243985000
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.