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": "教程",
      "link": "/markdown-examples"
    },
    {
      "text": "提示词构建",
      "link": "/reference/prompts"
    },
    {
      "text": "应用实例",
      "link": "/panorama/"
    }
  ],
  "sidebar": [
    {
      "text": "开始",
      "items": [
        {
          "text": "关于Stable Diffusion",
          "link": "/guide/introduction"
        },
        {
          "text": "腾讯云部署SD集成环境",
          "link": "/guide/installation/tencent-cloud"
        }
      ]
    },
    {
      "text": "基础",
      "items": [
        {
          "text": "howitworks",
          "link": "/howitworks/"
        }
      ]
    },
    {
      "text": "原理",
      "items": [
        {
          "text": "Panorama",
          "link": "/panorama/"
        }
      ]
    },
    {
      "text": "Panorama",
      "items": [
        {
          "text": "Panorama",
          "link": "/panorama/"
        }
      ]
    },
    {
      "text": "Reference",
      "items": [
        {
          "text": "Basic Parameters",
          "link": "/reference/basic_parameter"
        },
        {
          "text": "Prompts",
          "link": "/reference/prompts"
        },
        {
          "text": "Composition",
          "link": "/reference/composition"
        }
      ]
    }
  ],
  "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.