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

{
  "outlineTitle": "Sayfa İçeriği",
  "search": {
    "provider": "local",
    "options": {
      "detailedView": true,
      "translations": {
        "button": {
          "buttonText": "Ara",
          "buttonAriaLabel": "Sitede arama yap"
        },
        "modal": {
          "noResultsText": "Sonuç bulunamadı",
          "resetButtonTitle": "Aramayı sıfırla",
          "footer": {
            "selectText": "seçmek için",
            "navigateText": "gezinmek için",
            "closeText": "kapatmak için"
          }
        }
      }
    }
  },
  "nav": [
    {
      "text": "Ana Sayfa",
      "link": "/"
    },
    {
      "text": "Kaynaklar",
      "items": [
        {
          "text": "🎬 Film, Dizi & Belgesel",
          "link": "/kaynaklar/film-dizi-belgesel"
        },
        {
          "text": "📚 Kitap, Makale & Dergi",
          "link": "/kaynaklar/kitap-makale-dergi"
        },
        {
          "text": "🎧 Podcast, Radyo & Sesli Kitap",
          "link": "/kaynaklar/podcast-radyo-sesli-kitap"
        },
        {
          "text": "🗣️ Pratik & Forumlar",
          "link": "/kaynaklar/pratik-forumlar"
        },
        {
          "text": "🛠️ Araçlar & Uygulamalar",
          "link": "/kaynaklar/araclar"
        }
      ]
    },
    {
      "text": "SSS",
      "link": "/sss"
    }
  ],
  "sidebar": {
    "/": [
      {
        "text": "Giriş",
        "items": [
          {
            "text": "🚀 Başlangıç",
            "link": "/baslangic"
          },
          {
            "text": "📖 Site Kullanımı",
            "link": "/site-kullanimi"
          },
          {
            "text": "❓ SSS",
            "link": "/sss"
          }
        ]
      },
      {
        "text": "Kaynaklar",
        "collapsed": false,
        "items": [
          {
            "text": "🎬 Film, Dizi & Belgesel",
            "link": "/kaynaklar/film-dizi-belgesel"
          },
          {
            "text": "📚 Kitap, Makale & Dergi",
            "link": "/kaynaklar/kitap-makale-dergi"
          },
          {
            "text": "🎧 Podcast, Radyo & Sesli Kitap",
            "link": "/kaynaklar/podcast-radyo-sesli-kitap"
          },
          {
            "text": "🗣️ Pratik & Forumlar",
            "link": "/kaynaklar/pratik-forumlar"
          },
          {
            "text": "🛠️ Araçlar & Uygulamalar",
            "link": "/kaynaklar/araclar"
          }
        ]
      },
      {
        "text": "Öneriler",
        "collapsed": false,
        "items": [
          {
            "text": "🌍 Dil Öğrenimi",
            "link": "/oneriler/dil-ogrenimi"
          },
          {
            "text": "📝 Sınav",
            "link": "/oneriler/sinav"
          }
        ]
      }
    ]
  },
  "docFooter": {
    "prev": "Önceki Sayfa",
    "next": "Sonraki Sayfa"
  },
  "returnToTopLabel": "Yukarı dön",
  "sidebarMenuLabel": "Menü",
  "darkModeSwitchLabel": "Görünüm",
  "lightModeSwitchTitle": "Açık Moda Geç",
  "darkModeSwitchTitle": "Karanlık Moda Geç",
  "lastUpdatedText": "Son Güncelleme",
  "socialLinks": [
    {
      "icon": "telegram",
      "link": "https://t.me/EnglishAFL"
    }
  ],
  "footer": {
    "message": "Made with 🧡 by <a href=\"https://t.me/dreampiuv\" target=\"_blank\" rel=\"noopener noreferrer\">dreampiuv</a>"
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "title": "Runtime API Examples",
    "outline": "deep"
  },
  "headers": [
    {
      "level": 2,
      "title": "Results",
      "slug": "results",
      "link": "#results",
      "children": [
        {
          "level": 3,
          "title": "Theme Data",
          "slug": "theme-data",
          "link": "#theme-data",
          "children": []
        },
        {
          "level": 3,
          "title": "Page Data",
          "slug": "page-data",
          "link": "#page-data",
          "children": []
        },
        {
          "level": 3,
          "title": "Page Frontmatter",
          "slug": "page-frontmatter",
          "link": "#page-frontmatter",
          "children": []
        }
      ]
    },
    {
      "level": 2,
      "title": "More",
      "slug": "more",
      "link": "#more",
      "children": []
    }
  ],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md",
  "lastUpdated": 1755094641000
}

Page Frontmatter

{
  "title": "Runtime API Examples",
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.