diff options
Diffstat (limited to 'api-examples.md')
| -rw-r--r-- | api-examples.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/api-examples.md b/api-examples.md new file mode 100644 index 0000000..6bd8bb5 --- /dev/null +++ b/api-examples.md @@ -0,0 +1,49 @@ +--- +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 { 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 +<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.dev/reference/runtime-api#usedata). |
