# VitePress Runtime API

**Canonical:** https://apis.io/apis/vitepress/runtime-api/  
**Provider:** VitePress — https://apis.io/providers/vitepress/  
**Base URL:** https://vitepress.dev  
**Documentation:** https://vitepress.dev/reference/runtime-api

VitePress Runtime API is one of 2 APIs that [VitePress](https://apis.io/providers/vitepress/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Composables, Documentation, JavaScript, Runtime, and Vue. The published artifact set on APIs.io includes API documentation and an API reference.

The VitePress Runtime API provides Vue composition functions and helper utilities for use in custom themes, Vue components, and Markdown pages. Key composables include useData() for accessing site and page metadata, useRoute() for current route information, useRouter() for programmatic navigation, and withBase() for base URL resolution. Components include Content for rendering compiled Markdown and ClientOnly for browser-only rendering.

## Machine-readable artifacts (3)

- **Documentation** — https://vitepress.dev/reference/runtime-api
- **Reference** — https://vitepress.dev/reference/site-config
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/vitepress/refs/heads/main/apis.yml

## Other VitePress APIs (1)

- [VitePress Site Configuration](https://apis.io/apis/vitepress/site-config/)

## Tags

Composables, Documentation, JavaScript, Runtime, Vue

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/vitepress/runtime-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/vitepress/.