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": "/"
    },
    {
      "text": "文档",
      "link": "/docs"
    },
    {
      "text": "博客",
      "link": "/blogs"
    },
    {
      "text": "常见问题",
      "link": "/faq"
    }
  ],
  "sidebar": {
    "/docs/": {
      "base": "/docs/",
      "items": [
        {
          "text": "介绍",
          "link": "01-介绍/01-什么是ArkShell.md"
        }
      ]
    },
    "/blogs/": {
      "base": "/blogs/",
      "items": [
        {
          "text": "1. 终端发展史",
          "link": "01-终端发展史/01-终端发展史.md"
        }
      ]
    },
    "/api/": {
      "base": "/api/",
      "items": [
        {
          "text": "核心 API",
          "link": "core"
        },
        {
          "text": "命令行接口",
          "link": "cli"
        },
        {
          "text": "插件系统",
          "link": "plugins"
        }
      ]
    }
  },
  "footer": {
    "copyright": "© 2023 bit-labs. All rights reserved. 黔ICP备2024035961号"
  },
  "search": {
    "provider": "local"
  }
}

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.