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
{
"logo": "/pb-logo.svg",
"search": {
"provider": "algolia",
"options": {
"appId": "R3VCHBR5R7",
"apiKey": "18e96e5ac173075db51dc587b50ab41f",
"indexName": "paperback"
}
},
"nav": [
{
"text": "Getting Started",
"link": "/getting-started/"
},
{
"text": "Guides",
"link": "/guides/"
},
{
"text": "FAQ",
"link": "/faq/"
}
],
"socialLinks": [
{
"icon": "discord",
"link": "https://discord.paperback.moe",
"ariaLabel": "Official Discord"
},
{
"icon": "x",
"link": "https://x.com/paperbackios",
"ariaLabel": "X Profile"
},
{
"icon": {
"svg": "<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 38 42'> <path fill='currentColor' d='M36.975 12.392c0 .312.021.627-.004.937-.03.361-.082.722-.149 1.08a22.535 22.535 0 0 1-.331 1.512 8.59 8.59 0 0 1-.359 1.084c-.313.767-.66 1.518-1.117 2.21-.282.427-.57.849-.864 1.266a4.12 4.12 0 0 1-.37.431c-.225.238-.442.483-.686.695a13.5 13.5 0 0 1-1.123.905c-.356.25-.756.431-1.12.674-.404.268-.866.384-1.296.587-.384.18-.795.24-1.186.38-.498.18-1.021.222-1.531.331-.544.117-1.097.203-1.643.315-.449.09-.894.198-1.34.298-.254.056-.51.098-.756.173-.304.093-.6.214-.896.324-.201.072-.412.126-.604.219-.28.14-.544.315-.823.464-.457.242-.838.585-1.184.96-.292.32-.546.681-.8 1.036-.418.587-.706 1.244-.964 1.916-.254.657-.487 1.322-.725 1.986-.221.625-.43 1.252-.655 1.875a63.989 63.989 0 0 1-.618 1.615 13.447 13.447 0 0 1-1.12 2.215c-.331.531-.685 1.049-1.142 1.478-.366.343-.72.704-1.17.944-.446.24-.906.448-1.4.557a6.635 6.635 0 0 1-1.807.129c-.229-.012-.455-.075-.684-.117-.137-.026-.276-.047-.409-.089-.112-.035-.215-.097-.322-.151-.302-.147-.624-.264-.9-.448a8.802 8.802 0 0 1-.96-.776c-.554-.492-.97-1.103-1.342-1.74a13.04 13.04 0 0 1-.681-1.319c-.192-.436-.336-.893-.492-1.345a24.916 24.916 0 0 1-.34-1.063c-.092-.317-.165-.641-.243-.963-.073-.298-.15-.594-.212-.895-.112-.536-.215-1.073-.32-1.609a35.827 35.827 0 0 1-.133-.68c-.06-.34-.114-.681-.171-1.022-.044-.254-.092-.506-.13-.76-.044-.28-.08-.56-.124-.839-.036-.242-.078-.483-.112-.725-.032-.226-.06-.452-.089-.678a70.008 70.008 0 0 1-.094-.73c-.03-.236-.055-.471-.082-.707l-.096-.818c-.011-.098-.023-.193-.03-.291-.034-.401-.068-.804-.1-1.208a20.67 20.67 0 0 1-.05-.75c-.021-.39-.042-.777-.05-1.166A94.453 94.453 0 0 1 1 18.18c0-.378.002-.755.027-1.13.026-.392.08-.784.122-1.176.034-.312.064-.622.105-.934.023-.175.064-.348.1-.52.092-.432.176-.863.281-1.292.076-.31.181-.61.266-.916.157-.571.393-1.11.624-1.653.105-.25.235-.49.367-.725.186-.329.366-.66.576-.97.259-.378.533-.744.823-1.098a12.9 12.9 0 0 1 .873-.965c.24-.24.512-.448.77-.665.254-.212.501-.433.77-.624.412-.296.835-.576 1.263-.849.249-.158.514-.294.774-.434.405-.219.81-.44 1.22-.648.26-.13.527-.244.794-.354.683-.277 1.364-.557 2.055-.816.46-.17.932-.303 1.399-.452.24-.077.475-.161.717-.229.2-.056.402-.086.604-.133.22-.05.434-.119.656-.16.299-.059.603-.1.907-.147.34-.052.679-.105 1.02-.152.139-.019.283-.02.425-.03.47-.026.944-.054 1.414-.077.188-.01.382-.051.565-.019.443.08.889.017 1.332.05.428.03.853.076 1.278.127.306.038.608.103.914.15.268.04.535.065.802.107.215.035.43.081.645.128.46.103.919.196 1.374.317.404.11.797.275 1.204.37.469.113.899.332 1.351.479.462.149.86.424 1.3.608.515.217.96.546 1.418.858.347.238.685.492 1 .77.467.41.92.836 1.356 1.28.258.26.478.564.713.85.38.464.658.993.928 1.523.215.424.393.874.537 1.329.12.373.156.774.245 1.156.098.42.096.844.073 1.27l-.012.008z' ></path></svg>"
},
"link": "https://www.patreon.com/FaizanDurrani",
"ariaLabel": "Patreon Profile"
},
{
"icon": "github",
"link": "https://github.com/paperback-ios/app",
"ariaLabel": "App GitHub Repository"
},
{
"icon": {
"svg": "<svg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' class='bi bi-gear' viewBox='0 0 16 16'><path d='M8 4.754a3.246 3.246 0 1 0 0 6.492 3.246 3.246 0 0 0 0-6.492zM5.754 8a2.246 2.246 0 1 1 4.492 0 2.246 2.246 0 0 1-4.492 0z'/><path d='M9.796 1.343c-.527-1.79-3.065-1.79-3.592 0l-.094.319a.873.873 0 0 1-1.255.52l-.292-.16c-1.64-.892-3.433.902-2.54 2.541l.159.292a.873.873 0 0 1-.52 1.255l-.319.094c-1.79.527-1.79 3.065 0 3.592l.319.094a.873.873 0 0 1 .52 1.255l-.16.292c-.892 1.64.901 3.434 2.541 2.54l.292-.159a.873.873 0 0 1 1.255.52l.094.319c.527 1.79 3.065 1.79 3.592 0l.094-.319a.873.873 0 0 1 1.255-.52l.292.16c1.64.893 3.434-.902 2.54-2.541l-.159-.292a.873.873 0 0 1 .52-1.255l.319-.094c1.79-.527 1.79-3.065 0-3.592l-.319-.094a.873.873 0 0 1-.52-1.255l.16-.292c.893-1.64-.902-3.433-2.541-2.54l-.292.159a.873.873 0 0 1-1.255-.52l-.094-.319zm-2.633.283c.246-.835 1.428-.835 1.674 0l.094.319a1.873 1.873 0 0 0 2.693 1.115l.291-.16c.764-.415 1.6.42 1.184 1.185l-.159.292a1.873 1.873 0 0 0 1.116 2.692l.318.094c.835.246.835 1.428 0 1.674l-.319.094a1.873 1.873 0 0 0-1.115 2.693l.16.291c.415.764-.42 1.6-1.185 1.184l-.291-.159a1.873 1.873 0 0 0-2.693 1.116l-.094.318c-.246.835-1.428.835-1.674 0l-.094-.319a1.873 1.873 0 0 0-2.692-1.115l-.292.16c-.764.415-1.6-.42-1.184-1.185l.159-.291A1.873 1.873 0 0 0 1.945 8.93l-.319-.094c-.835-.246-.835-1.428 0-1.674l.319-.094A1.873 1.873 0 0 0 3.06 4.377l-.16-.292c-.415-.764.42-1.6 1.185-1.184l.292.159a1.873 1.873 0 0 0 2.692-1.115l.094-.319z'/></svg>"
},
"link": "https://portal.paperback.moe/",
"ariaLabel": "Paperback Portal"
}
],
"sidebar": [
{
"text": "Getting Started",
"link": "/getting-started/",
"collapsed": false,
"items": [
{
"text": "Download",
"link": "/getting-started/installation/",
"collapsed": true,
"items": [
{
"text": "App Store",
"link": "/getting-started/installation/appstore"
},
{
"text": "TestFlight",
"link": "/getting-started/installation/testflight"
},
{
"text": "Sideloading",
"link": "/getting-started/installation/sideloading"
}
]
},
{
"text": "Changing Content Settings",
"link": "/getting-started/content-settings"
},
{
"text": "Adding Content",
"link": "/getting-started/adding-content/",
"collapsed": true,
"items": [
{
"text": "Komga",
"link": "/getting-started/adding-content/komga"
},
{
"text": "Third-Party Extensions",
"link": "/getting-started/adding-content/third-party-extensions"
}
]
},
{
"text": "Further Support",
"link": "/getting-started/further-support/"
}
]
},
{
"text": "Guides",
"link": "/guides/",
"collapsed": false,
"items": [
{
"text": "Using the Reader",
"link": "/guides/reader"
},
{
"text": "Backing up Your Data",
"link": "/guides/backups"
},
{
"text": "Connecting Trackers",
"link": "/guides/trackers"
},
{
"text": "Migrating Extensions",
"link": "/guides/migrating"
},
{
"text": "Merging Titles",
"link": "/guides/merging"
},
{
"text": "Changing the Theme",
"link": "/guides/themes"
}
]
},
{
"text": "FAQ",
"link": "/faq/",
"collapsed": false,
"items": [
{
"text": "General",
"link": "/faq/general"
},
{
"text": "Troubleshooting",
"link": "/faq/troubleshooting"
}
]
}
],
"editLink": {
"pattern": "https://github.com/Paperback-iOS/website/tree/master/src/:path"
},
"footer": {
"copyright": "Copyright © 2023-present Paperback-iOS. MIT Licensed. <a href='/privacy-policy'>Privacy Policy.</a>"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "contributing/website/reference/api-examples.md",
"filePath": "contributing/website/reference/api-examples.md",
"lastUpdated": 1750338246000
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.