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": "/zh/"
    },
    {
      "text": "关于我们",
      "link": "/zh/"
    },
    {
      "text": "观点",
      "link": ""
    }
  ],
  "sidebar": [
    {
      "text": "Examples",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/produck"
    }
  ],
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "zh": {
          "translations": {
            "button": {
              "buttonText": "搜索文档",
              "buttonAriaLabel": "搜索文档"
            },
            "modal": {
              "noResultsText": "无法找到相关结果",
              "resetButtonTitle": "清除查询条件",
              "footer": {
                "selectText": "选择",
                "navigateText": "切换"
              }
            }
          }
        }
      }
    }
  },
  "footer": {
    "message": "基于 MIT 协议发布",
    "copyright": "Copyright © 2018-2024 Produck团队"
  },
  "editLink": {
    "pattern": "https://github.com/produck/home/edit/main/docs/:path",
    "text": "在GitHub上编辑"
  },
  "externalLinkIcon": true,
  "docFooter": {
    "prev": "上一章",
    "next": "下一章"
  },
  "outline": {
    "label": "页面导航"
  },
  "lastUpdated": {
    "text": "最后更新于"
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep",
    "footer": true
  },
  "headers": [],
  "relativePath": "zh/api-examples.md",
  "filePath": "zh/api-examples.md",
  "lastUpdated": 1708367639000
}

Page Frontmatter

{
  "outline": "deep",
  "footer": true
}

More

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