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"
    }
  ],
  "search": {
    "provider": "local"
  },
  "sidebar": [
    {
      "text": "开始",
      "collapsed": true,
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        },
        {
          "text": "数据处理",
          "link": "/docs/dataproc"
        }
      ]
    },
    {
      "text": "采集指南",
      "collapsed": true,
      "items": [
        {
          "text": "登陆",
          "link": "/docs/pages"
        },
        {
          "text": "列表模式",
          "link": "/docs/pages"
        },
        {
          "text": "分页采集",
          "link": "/docs/pages"
        },
        {
          "text": "json数据",
          "link": "/docs/json"
        },
        {
          "text": "POST请求",
          "link": "/docs/post"
        },
        {
          "text": "数据处理",
          "link": "/docs/dataproc"
        },
        {
          "text": "自定义数据",
          "link": "/docs/dataproc"
        },
        {
          "text": "批量生成网址",
          "link": "/docs/dataproc"
        }
      ]
    }
  ],
  "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.