成长之路

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": "/"
    },
    {
      "text": "技术文章",
      "link": "article/tech/start"
    },
    {
      "text": "My Road",
      "link": "article/other/myroad"
    },
    {
      "text": "资源分享",
      "link": "article/res-share/start"
    },
    {
      "text": "其他",
      "items": [
        {
          "text": "Item A",
          "link": "/item-1"
        },
        {
          "text": "Item B",
          "link": "/item-2"
        },
        {
          "text": "Item C",
          "link": "/item-3"
        }
      ]
    }
  ],
  "sidebar": {
    "/article/tech": [
      {
        "text": "Redis",
        "collapsed": false,
        "items": [
          {
            "text": "Redis 分布式锁",
            "link": "/article/tech/redis/redis_distributed_lock"
          },
          {
            "text": "One",
            "link": "/guide/one"
          },
          {
            "text": "Runtime API Examples",
            "link": "/api-examples"
          }
        ]
      },
      {
        "text": "Guide",
        "collapsed": false,
        "items": [
          {
            "text": "Markdown Examples",
            "link": "/markdown-examples"
          },
          {
            "text": "One",
            "link": "/guide/one"
          },
          {
            "text": "Runtime API Examples",
            "link": "/api-examples"
          }
        ]
      }
    ],
    "/config/": [
      {
        "text": "Config",
        "items": [
          {
            "text": "Index",
            "link": "/config/"
          },
          {
            "text": "Three",
            "link": "/config/three"
          },
          {
            "text": "Four",
            "link": "/config/four"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2024-2025 纳川 | 晋ICP备2024041275号-1"
  }
}

Page Data

{
  "title": "成长之路",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "article/other/myroad.md",
  "filePath": "article/other/myroad.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.