API Examples

This page demonstrates some VitePress runtime API usage examples.

useData()

The useData() helper provides access to the current page data.

<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

useRoute()

<script setup>
import { useRoute } from 'vitepress'

const route = useRoute()
</script>

Custom Components

You can use Vue components directly in Markdown files.

Badge Component

VitePress has a built-in Badge component:

• New feature new
• Warning beta
• Deprecated deprecated

More Resources

Visit VitePress Documentation for more APIs and features.