Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 994 Bytes

api-examples.md

File metadata and controls

51 lines (34 loc) · 994 Bytes
title description outline
Runtime API Examples
Examples of using the VitePress runtime APIs.
deep

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:

<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>
<script setup> import { useData } from 'vitepress' const { site, theme, page, frontmatter } = useData() </script>

Results

Theme Data

{{ theme }}

Page Data

{{ page }}

Page Frontmatter

{{ frontmatter }}

More

Check out the documentation for the full list of runtime APIs.