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": "/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    },
    {
      "text": "API",
      "link": "/api-examples"
    },
    {
      "text": "建站指南",
      "link": "/01_blog"
    }
  ],
  "sidebar": {
    "/": [
      {
        "text": "Guide",
        "items": [
          {
            "text": "Markdown Examples",
            "link": "/markdown-examples"
          },
          {
            "text": "Runtime API Examples",
            "link": "/api-examples"
          }
        ]
      }
    ],
    "/01_blog/": [
      {
        "text": "建站指南",
        "items": [
          {
            "text": "01 Getting Started",
            "link": "/01_blog/01_getting-started"
          },
          {
            "text": "02 Configuration",
            "link": "/01_blog/02_configuration"
          },
          {
            "text": "03 Content Organization",
            "link": "/01_blog/03_content-organization"
          },
          {
            "text": "04 Theme Customization",
            "link": "/01_blog/04_theme-customization"
          },
          {
            "text": "05 Deployment",
            "link": "/01_blog/05_deployment"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.