mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
56 lines
968 B
56 lines
968 B
2 years ago
|
---
|
||
|
|
outline: 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:
|
||
|
|
|
||
|
|
```md
|
||
|
|
<script setup>
|
||
|
|
import { useData } from 'vitepress'
|
||
|
|
|
||
|
|
const { site, theme, page, frontmatter } = useData()
|
||
|
|
</script>
|
||
|
|
|
||
|
|
## Results
|
||
|
|
|
||
|
|
### Site Data
|
||
|
|
<pre>{{ site }}</pre>
|
||
|
|
|
||
|
|
### 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
|
||
|
|
|
||
|
|
### Site Data
|
||
|
|
<pre>{{ site }}</pre>
|
||
|
|
|
||
|
|
### Theme Data
|
||
|
|
<pre>{{ theme }}</pre>
|
||
|
|
|
||
|
|
### Page Data
|
||
|
|
<pre>{{ page }}</pre>
|
||
|
|
|
||
|
|
### Page Frontmatter
|
||
|
|
<pre>{{ frontmatter }}</pre>
|
||
|
|
|
||
|
|
## More
|
||
|
|
|
||
|
|
Check out the documentation for the [full list of runtime APIs](https://vitepress.vuejs.org/api/).
|