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": "/image/logo-sub.png",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "指南",
      "link": "/quick-start"
    }
  ],
  "sidebar": [
    {
      "text": "快速上手",
      "link": "/quick-start"
    },
    {
      "text": "函数",
      "items": [
        {
          "text": "Number",
          "items": [
            {
              "text": "countDecimals 小数位数",
              "link": "/function/number/countDecimals"
            },
            {
              "text": "floatAdd 浮点相加",
              "link": "/function/number/floatAdd"
            }
          ]
        },
        {
          "text": "String",
          "items": [
            {
              "text": "lengthOf 获取长度",
              "link": "/function/string/lengthOf"
            }
          ]
        },
        {
          "text": "Array",
          "items": [
            {
              "text": "unique 去重",
              "link": "/function/array/unique"
            }
          ]
        },
        {
          "text": "Tree",
          "items": [
            {
              "text": "treeMap 树形映射",
              "link": "/function/tree/treeMap"
            },
            {
              "text": "treeSort 树形排序",
              "link": "/function/tree/treeSort"
            },
            {
              "text": "treeFilter 树形筛选",
              "link": "/function/tree/treeFilter"
            }
          ]
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/joo1es/utils"
    }
  ],
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2022-present"
  }
}

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.