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": "Welcome",
      "link": "/pages_welcome"
    }
  ],
  "sidebar": [
    {
      "text": "YouTube Channel",
      "link": "https://www.youtube.com/@digitalhistory7990"
    },
    {
      "text": "GitHub Repository",
      "link": "https://github.com/MaastrichtUniversityPress/distant-reading-textbook"
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/MaastrichtUniversityPress/distant-reading-textbook"
    }
  ],
  "notFound": {
    "title": "Page under construction",
    "quote": "This page is under construction. Go back to the main site or select another case study from the Task Sheets menu.",
    "linkText": "Return to home",
    "link": "/"
  }
}

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.