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

{
  "logo": "/logo.svg",
  "siteTitle": "好一二三",
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Guide",
      "link": "/guide"
    },
    {
      "text": "电脑小白",
      "link": "/guide"
    },
    {
      "text": "资源宝库",
      "link": "/guide"
    },
    {
      "text": "极客学院",
      "items": [
        {
          "text": "计算机基础",
          "link": "/item-1"
        },
        {
          "text": "人工智能",
          "link": "/item-2"
        },
        {
          "text": "项目推荐",
          "link": "/project"
        },
        {
          "text": "目标规划",
          "link": "/item-3"
        }
      ]
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": {
    "/guide/": [
      {
        "text": "Guide",
        "collapsed": true,
        "items": [
          {
            "text": "Index",
            "link": "/guide/"
          },
          {
            "text": "One",
            "link": "/guide/one"
          },
          {
            "text": "Two",
            "link": "/guide/two"
          }
        ]
      },
      {
        "text": "introduction",
        "collapsed": true,
        "items": [
          {
            "text": "Index",
            "link": "/guide/"
          },
          {
            "text": "One",
            "link": "/guide/one"
          },
          {
            "text": "Two",
            "link": "/guide/two"
          }
        ]
      }
    ],
    "/config/": [
      {
        "text": "Config",
        "collapsed": false,
        "items": [
          {
            "text": "Index",
            "link": "/config/"
          },
          {
            "text": "Three",
            "link": "/config/three"
          },
          {
            "text": "Four",
            "link": "/config/four"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/Agustletmen"
    },
    {
      "icon": "wechat",
      "link": ""
    },
    {
      "icon": "qq",
      "link": ""
    },
    {
      "icon": "bilibili",
      "link": "https://space.bilibili.com/119072332"
    }
  ],
  "search": {
    "provider": "local",
    "options": {
      "miniSearch": {
        "options": {},
        "searchOptions": {}
      }
    }
  }
}

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.