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": "IRR Tool",
      "link": "/centralized-pv-irr"
    },
    {
      "text": "Micro Storage",
      "link": "/pv-micro-storage-cost"
    },
    {
      "text": "Degree English",
      "link": "/degree-english/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "Tools",
      "items": [
        {
          "text": "集中式光伏增量 IRR 测算",
          "link": "/centralized-pv-irr"
        },
        {
          "text": "光伏场站微储能成本测算",
          "link": "/pv-micro-storage-cost"
        }
      ]
    },
    {
      "text": "Degree English",
      "items": [
        {
          "text": "练习站首页",
          "link": "/degree-english/"
        },
        {
          "text": "试卷题",
          "link": "/degree-english/exams"
        },
        {
          "text": "训练包",
          "link": "/degree-english/training"
        },
        {
          "text": "错题与记录",
          "link": "/degree-english/progress"
        }
      ]
    },
    {
      "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"
    }
  ]
}

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.