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": "我的开源项目",
      "items": [
        {
          "text": "言磊星辰(爸爸的爱)",
          "link": "https://jianlee.cn/star"
        },
        {
          "text": "我的GitHub",
          "link": "https://github.com/LiJianStudio"
        },
        {
          "text": "npm依赖包",
          "link": "https://www.npmjs.com/~lijian_studio"
        },
        {
          "text": "uniapp插件",
          "link": "https://ext.dcloud.net.cn/publisher?id=172739"
        },
        {
          "text": "gitee",
          "link": "https://gitee.com/LiJianStudio"
        },
        {
          "text": "coding",
          "link": "https://lijianstudio.coding.net/user"
        },
        {
          "text": "我的语雀",
          "link": "https://www.yuque.com/jianlee"
        },
        {
          "text": "CSDN博客",
          "link": "https://blog.csdn.net/JianLee"
        }
      ]
    }
  ],
  "sidebar": [
    {
      "text": "JLUI库",
      "items": [
        {
          "text": "使用方法",
          "link": "/src/jlui/index"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    },
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/LiJianStudio"
    }
  ]
}

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.