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:

<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": "/qplaylogo-symbol.svg",
  "search": {
    "provider": "local",
    "options": {
      "translations": {
        "button": {
          "buttonText": "Sök",
          "buttonAriaLabel": "Sök"
        },
        "modal": {
          "displayDetails": "Visa detaljer",
          "resetButtonTitle": "Rensa sökning",
          "backButtonTitle": "Stäng sökning",
          "noResultsText": "Inga resultat för",
          "footer": {
            "selectText": "välj",
            "navigateText": "navigera",
            "closeText": "stäng",
            "closeKeyAriaLabel": "escape"
          }
        }
      }
    }
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/YOUR_USERNAME/qplay-docs"
    }
  ],
  "nav": [
    {
      "text": "Hem",
      "link": "/"
    },
    {
      "text": "Kom igång",
      "link": "/kom-igang"
    }
  ],
  "sidebar": [
    {
      "text": "Kom igång",
      "collapsed": false,
      "items": [
        {
          "text": "Vad är QPlay?",
          "link": "/vad-ar-qplay"
        },
        {
          "text": "Kom igång",
          "link": "/kom-igang"
        },
        {
          "text": "Kompatibilitet med QPlay",
          "link": "/kompatibilitet"
        },
        {
          "text": "Behövs IPTV-box?",
          "link": "/behovs-iptv-box"
        },
        {
          "text": "QPlay i Utlandet",
          "link": "/qplay-i-utlandet"
        }
      ]
    },
    {
      "text": "Konto & Abonnemang",
      "collapsed": false,
      "items": [
        {
          "text": "Orderbekräftelse",
          "link": "/orderbekraftelse"
        },
        {
          "text": "Automatisk förnyelse",
          "link": "/automatisk-fornyelse"
        },
        {
          "text": "Ändra innehåll",
          "link": "/andra-innehall"
        },
        {
          "text": "Avsluta QPlay",
          "link": "/avsluta-qplay"
        },
        {
          "text": "Vuxet innehåll",
          "link": "/vuxet-innehall"
        }
      ]
    },
    {
      "text": "Teknik & Format",
      "collapsed": false,
      "items": [
        {
          "text": "Xtream vs. M3U",
          "link": "/xtream-vs-m3u"
        },
        {
          "text": "RAW vs. HD/4K",
          "link": "/raw-vs-hd-4k"
        },
        {
          "text": "Svensk undertext",
          "link": "/svensk-undertext"
        }
      ]
    },
    {
      "text": "Appar & Enheter",
      "collapsed": false,
      "items": [
        {
          "text": "App till LG/Samsung TV",
          "link": "/app-lg-samsung"
        },
        {
          "text": "Bästa app Apple TV",
          "link": "/basta-app-apple-tv"
        },
        {
          "text": "App Android mobil",
          "link": "/app-android-mobil"
        },
        {
          "text": "Guide TiviMate",
          "link": "/guide-tivimate"
        },
        {
          "text": "Guide UHF",
          "link": "/guide-uhf"
        },
        {
          "text": "Ibo Player",
          "link": "/ibo-player"
        },
        {
          "text": "SET IPTV",
          "link": "/set-iptv"
        },
        {
          "text": "TVIP",
          "link": "/tvip"
        },
        {
          "text": "Formuler IPTV-box",
          "link": "/formuler-iptv-box"
        }
      ]
    },
    {
      "text": "Sport",
      "collapsed": false,
      "items": [
        {
          "text": "Allsvenskan",
          "link": "/allsvenskan"
        },
        {
          "text": "Superettan",
          "link": "/superettan"
        }
      ]
    }
  ],
  "outlineTitle": "På denna sida",
  "returnToTopLabel": "Tillbaka till toppen",
  "sidebarMenuLabel": "Meny",
  "darkModeSwitchLabel": "Utseende",
  "docFooter": {
    "prev": "Föregående sida",
    "next": "Nästa sida"
  }
}

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.