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>Results
Theme Data
{
"nav": [
{
"text": "首页",
"link": "/"
},
{
"text": "预科班",
"link": "/matriculation"
},
{
"text": "本科班",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 00"
},
{
"text": "Examples",
"link": "/markdown-examples"
}
],
"sidebar": {
"/undergraduate/": [
{
"text": "楞严经",
"collapsed": true,
"items": [
{
"text": "00",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 00"
},
{
"text": "01",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 01"
},
{
"text": "02",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 02"
},
{
"text": "03",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 03"
},
{
"text": "04",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 04"
},
{
"text": "05",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 05"
},
{
"text": "06",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 06"
},
{
"text": "07",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 07"
},
{
"text": "08",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 08"
},
{
"text": "09",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 09"
},
{
"text": "10",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 10"
},
{
"text": "11",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 11"
},
{
"text": "12",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 12"
},
{
"text": "13",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 13"
},
{
"text": "14",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 14"
},
{
"text": "15",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 15"
},
{
"text": "16",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 16"
},
{
"text": "17",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 17"
},
{
"text": "18",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 18"
},
{
"text": "19",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 19"
},
{
"text": "20",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 20"
},
{
"text": "21",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 21"
},
{
"text": "22",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 22"
},
{
"text": "23",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 23"
},
{
"text": "24",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 24"
},
{
"text": "25",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 25"
},
{
"text": "26",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 26"
},
{
"text": "27",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 27"
},
{
"text": "28",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 28"
},
{
"text": "29",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 29"
},
{
"text": "30",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 30"
},
{
"text": "31",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 31"
},
{
"text": "32",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 32"
},
{
"text": "33",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 33"
},
{
"text": "34",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 34"
},
{
"text": "35",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 35"
},
{
"text": "36",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 36"
},
{
"text": "37",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 37"
},
{
"text": "38",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 38"
},
{
"text": "39",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 39"
},
{
"text": "40",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 40"
},
{
"text": "41",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 41"
},
{
"text": "42",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 42"
},
{
"text": "43",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 43"
},
{
"text": "44",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 44"
},
{
"text": "45",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 45"
},
{
"text": "46",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 46"
},
{
"text": "47",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 47"
},
{
"text": "48",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 48"
},
{
"text": "49",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 49"
},
{
"text": "50",
"link": "/undergraduate/15SurangamaSutra/15 SurangamaSutra 50"
},
{
"text": "Runtime API Examples",
"link": "/api-examples"
}
]
},
{
"text": "金刚经",
"collapsed": true,
"items": [
{
"text": "00",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 00"
},
{
"text": "01",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 01"
},
{
"text": "02",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 02"
},
{
"text": "03",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 03"
},
{
"text": "04",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 04"
},
{
"text": "05",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 05"
},
{
"text": "06",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 06"
},
{
"text": "07",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 07"
},
{
"text": "08",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 08"
},
{
"text": "09",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 09"
},
{
"text": "10",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 10"
},
{
"text": "11",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 11"
},
{
"text": "12",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 12"
},
{
"text": "13",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 13"
},
{
"text": "14",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 13"
},
{
"text": "15",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 15"
},
{
"text": "16",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 16"
},
{
"text": "17",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 17"
},
{
"text": "18",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 18"
},
{
"text": "19",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 19"
},
{
"text": "20",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 20"
},
{
"text": "21",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 21"
},
{
"text": "22",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 22"
},
{
"text": "23",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 23"
},
{
"text": "24",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 24"
},
{
"text": "25",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 25"
},
{
"text": "26",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 26"
},
{
"text": "27",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 27"
},
{
"text": "28",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 28"
},
{
"text": "29",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 29"
},
{
"text": "30",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 30"
},
{
"text": "31",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 31"
},
{
"text": "32",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 32"
},
{
"text": "33",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 33"
},
{
"text": "34",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 34"
},
{
"text": "35",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 35"
},
{
"text": "36",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 36"
},
{
"text": "37",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 37"
},
{
"text": "38",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 38"
},
{
"text": "39",
"link": "/undergraduate/13DiamondSutra/13 DiamondSutra 39"
}
]
},
{
"text": "物不迁论",
"collapsed": true,
"items": [
{
"text": "00",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 00"
},
{
"text": "01",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 01"
},
{
"text": "02",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 02"
},
{
"text": "03",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 03"
},
{
"text": "04",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 04"
},
{
"text": "05",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 05"
},
{
"text": "06",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 06"
},
{
"text": "07",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 07"
},
{
"text": "08",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 08"
},
{
"text": "09",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 09"
},
{
"text": "10",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 10"
},
{
"text": "11",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 11"
},
{
"text": "12",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 12"
},
{
"text": "13",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 13"
},
{
"text": "14",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 13"
},
{
"text": "15",
"link": "/undergraduate/17OntheStaticStateofThings/17 OntheStaticStateofThings 15"
}
]
},
{
"text": "大乘百法明门论",
"collapsed": true,
"items": [
{
"text": "01",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 01"
},
{
"text": "02",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 02"
},
{
"text": "03",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 03"
},
{
"text": "04",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 04"
},
{
"text": "05",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 05"
},
{
"text": "06",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 06"
},
{
"text": "07",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 07"
},
{
"text": "08",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 08"
},
{
"text": "09",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 09"
},
{
"text": "10",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 10"
},
{
"text": "11",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 11"
},
{
"text": "12",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 12"
},
{
"text": "13",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 13"
},
{
"text": "14",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 13"
},
{
"text": "15",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 15"
},
{
"text": "16",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 16"
},
{
"text": "17",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 17"
},
{
"text": "18",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 18"
},
{
"text": "19",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 19"
},
{
"text": "20",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 20"
},
{
"text": "21",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 21"
},
{
"text": "22",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 22"
},
{
"text": "23",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 23"
},
{
"text": "24",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 24"
},
{
"text": "25",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 25"
},
{
"text": "26",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 26"
},
{
"text": "27",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 27"
},
{
"text": "28",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 28"
},
{
"text": "29",
"link": "/undergraduate/18OneHundredDharmas/18 OneHundredDharmas 29"
}
]
},
{
"text": "八识规矩颂",
"collapsed": true,
"items": [
{
"text": "00",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 00"
},
{
"text": "01",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 01"
},
{
"text": "02",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 02"
},
{
"text": "03",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 03"
},
{
"text": "04",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 04"
},
{
"text": "05",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 05"
},
{
"text": "06",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 06"
},
{
"text": "07",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 07"
},
{
"text": "08",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 08"
},
{
"text": "09",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 09"
},
{
"text": "10",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 10"
},
{
"text": "11",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 11"
},
{
"text": "12",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 12"
},
{
"text": "13",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 13"
},
{
"text": "14",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 13"
},
{
"text": "15",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 15"
},
{
"text": "16",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 16"
},
{
"text": "17",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 17"
},
{
"text": "18",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 18"
},
{
"text": "19",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 19"
},
{
"text": "20",
"link": "/undergraduate/19VersesDelineatingtheEightConsciousnesses/19 VersesDelineatingtheEightConsciousnesses 20"
}
]
}
]
},
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/vuejs/vitepress"
}
]
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md"
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.