File tree Expand file tree Collapse file tree 2 files changed +134
-0
lines changed Expand file tree Collapse file tree 2 files changed +134
-0
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ outline : deep
3
+ ---
4
+
5
+ # Runtime API Examples
6
+
7
+ This page demonstrates usage of some of the runtime APIs provided by VitePress.
8
+
9
+ 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:
10
+
11
+ ``` md
12
+ <script setup>
13
+ import { useData } from 'vitepress'
14
+
15
+ const { theme, page, frontmatter } = useData()
16
+ </script>
17
+
18
+ ## Results
19
+
20
+ ### Theme Data
21
+ <pre>{{ theme }}</pre>
22
+
23
+ ### Page Data
24
+ <pre>{{ page }}</pre>
25
+
26
+ ### Page Frontmatter
27
+ <pre>{{ frontmatter }}</pre>
28
+ ```
29
+
30
+ <script setup >
31
+ import { useData } from ' vitepress'
32
+
33
+ const { site , theme , page , frontmatter } = useData ()
34
+ </script >
35
+
36
+ ## Results
37
+
38
+ ### Theme Data
39
+ <pre >{{ theme }}</pre >
40
+
41
+ ### Page Data
42
+ <pre >{{ page }}</pre >
43
+
44
+ ### Page Frontmatter
45
+ <pre >{{ frontmatter }}</pre >
46
+
47
+ ## More
48
+
49
+ Check out the documentation for the [ full list of runtime APIs] ( https://vitepress.dev/reference/runtime-api#usedata ) .
Original file line number Diff line number Diff line change
1
+ # Markdown Extension Examples
2
+
3
+ This page demonstrates some of the built-in markdown extensions provided by VitePress.
4
+
5
+ ## Syntax Highlighting
6
+
7
+ VitePress provides Syntax Highlighting powered by [ Shiki] ( https://github.com/shikijs/shiki ) , with additional features like line-highlighting:
8
+
9
+ ** Input**
10
+
11
+ ```` md
12
+ ```js{4}
13
+ export default {
14
+ data () {
15
+ return {
16
+ msg: 'Highlighted!'
17
+ }
18
+ }
19
+ }
20
+ ```
21
+ ````
22
+
23
+ ** Output**
24
+
25
+ ``` js{4}
26
+ export default {
27
+ data () {
28
+ return {
29
+ msg: 'Highlighted!'
30
+ }
31
+ }
32
+ }
33
+ ```
34
+
35
+ ## Custom Containers
36
+
37
+ ** Input**
38
+
39
+ ``` md
40
+ ::: info
41
+ This is an info box.
42
+ :::
43
+
44
+ ::: tip
45
+ This is a tip.
46
+ :::
47
+
48
+ ::: warning
49
+ This is a warning.
50
+ :::
51
+
52
+ ::: danger
53
+ This is a dangerous warning.
54
+ :::
55
+
56
+ ::: details
57
+ This is a details block.
58
+ :::
59
+ ```
60
+
61
+ ** Output**
62
+
63
+ ::: info
64
+ This is an info box.
65
+ :::
66
+
67
+ ::: tip
68
+ This is a tip.
69
+ :::
70
+
71
+ ::: warning
72
+ This is a warning.
73
+ :::
74
+
75
+ ::: danger
76
+ This is a dangerous warning.
77
+ :::
78
+
79
+ ::: details
80
+ This is a details block.
81
+ :::
82
+
83
+ ## More
84
+
85
+ Check out the documentation for the [ full list of markdown extensions] ( https://vitepress.dev/guide/markdown ) .
You can’t perform that action at this time.
0 commit comments