aboutsummaryrefslogtreecommitdiffstats
path: root/api-examples.md
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2024-04-07 01:19:17 -0700
committerPinapelz <yukais@pinapelz.com>2024-04-07 01:19:17 -0700
commitc95c0a56cd994ff09c3aee767949a88752642409 (patch)
tree0d89cb2e4a17cd8c004b3b2a3a1e648f1b720492 /api-examples.md
parent8e1b5f1acb359bdd2fd8fa644f97274e6429b779 (diff)
migrate docs to vitepress
Diffstat (limited to 'api-examples.md')
-rw-r--r--api-examples.md49
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).
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage