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

{
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "fr": {
          "translations": {
            "button": {
              "buttonText": "Rechercher",
              "buttonAriaLabel": "Rechercher"
            },
            "modal": {
              "noResultsText": "Aucun résultat pour",
              "resetButtonTitle": "Réinitialiser la recherche",
              "footer": {
                "selectText": "Sélectionner",
                "navigateText": "Naviguer",
                "closeText": "Fermer"
              }
            }
          }
        },
        "en": {
          "translations": {
            "button": {
              "buttonText": "Search",
              "buttonAriaLabel": "Search"
            },
            "modal": {
              "noResultsText": "No results for",
              "resetButtonTitle": "Reset search",
              "footer": {
                "selectText": "Select",
                "navigateText": "Navigate",
                "closeText": "Close"
              }
            }
          }
        },
        "ar": {
          "translations": {
            "button": {
              "buttonText": "بحث",
              "buttonAriaLabel": "بحث"
            },
            "modal": {
              "noResultsText": "لا توجد نتائج لـ",
              "resetButtonTitle": "إعادة تعيين البحث",
              "footer": {
                "selectText": "اختر",
                "navigateText": "تنقل",
                "closeText": "إغلاق"
              }
            }
          }
        }
      }
    }
  },
  "nav": [
    {
      "text": "Accueil",
      "link": "/"
    },
    {
      "text": "Commencer",
      "link": "/getting-started"
    },
    {
      "text": "Guides",
      "link": "/guides/overview"
    },
    {
      "text": "FAQ",
      "link": "/faq"
    }
  ],
  "sidebar": {
    "/guides/": [
      {
        "text": "Guides Utilisateur",
        "items": [
          {
            "text": "Gestion des Clients",
            "link": "/guides/clients"
          },
          {
            "text": "Gestion des Produits",
            "link": "/guides/products"
          },
          {
            "text": "Gestion des Livreurs",
            "link": "/guides/carriers"
          },
          {
            "text": "Gestion des Promotions",
            "link": "/guides/promotions"
          },
          {
            "text": "Gestion des Objectifs",
            "link": "/guides/goals"
          },
          {
            "text": "Gestion des Circuits",
            "link": "/guides/circuits"
          },
          {
            "text": "Gestion des Programmes",
            "link": "/guides/programs"
          },
          {
            "text": "Caisses & Mouvements",
            "link": "/guides/caisses-moves"
          },
          {
            "text": "Gestion des Secteurs",
            "link": "/guides/sectors"
          },
          {
            "text": "Paiements",
            "link": "/guides/operations-payments"
          },
          {
            "text": "Livraisons",
            "link": "/guides/operations-deliveries"
          },
          {
            "text": "Commandes",
            "link": "/guides/operations-orders"
          },
          {
            "text": "Retours",
            "link": "/guides/operations-returns"
          },
          {
            "text": "Tableaux de bord personnalisés",
            "link": "/guides/custom-dashboard"
          }
        ]
      }
    ],
    "/": [
      {
        "text": "Commencer",
        "items": [
          {
            "text": "Bienvenue",
            "link": "/getting-started"
          }
        ]
      },
      {
        "text": "Aide",
        "items": [
          {
            "text": "FAQ",
            "link": "/faq"
          }
        ]
      }
    ]
  },
  "footer": {
    "message": "Besoin d'aide ? Contactez notre équipe de support",
    "copyright": "Copyright © 2026 Distritour"
  }
}

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.