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

{
  "nav": [
    {
      "text": "Home",
      "link": "/hj"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "search": {
    "provider": "local"
  },
  "lastUpdated": {
    "text": "Last Updated",
    "formatOptions": {
      "dateStyle": "full"
    }
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "populate this section so that llm's have more context on what a given page is about.",
  "frontmatter": {
    "outline": "deep",
    "description": "populate this section so that llm's have more context on what a given page is about."
  },
  "headers": [],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md",
  "lastUpdated": 1754068039000
}

Page Frontmatter

{
  "outline": "deep",
  "description": "populate this section so that llm's have more context on what a given page is about."
}

More

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