• Results
  • Theme Data
  • Page Data
  • Page Frontmatter
• More

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": "/pages/posts"
    },
    {
      "text": "分类",
      "link": "/pages/category"
    }
  ],
  "docCount": 5,
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2019-present Su-77"
  },
  "aside": false,
  "blogImg": true,
  "blogList": {
    "isBlogImages": true,
    "imagesLocation": "leftRight"
  },
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "zh": {
          "translations": {
            "button": {
              "buttonText": "搜索文档",
              "buttonAriaLabel": "搜索文档"
            },
            "modal": {
              "noResultsText": "无法找到相关结果",
              "resetButtonTitle": "清除查询条件",
              "footer": {
                "selectText": "选择",
                "navigateText": "切换"
              }
            }
          }
        }
      }
    }
  }
}

Page Data

{
  "title": "置顶文章",
  "description": "",
  "frontmatter": {
    "outline": "deep",
    "title": "置顶文章",
    "date": "2021-01-11T00:00:00.000Z",
    "category": [
      "Iconify",
      "Tailwind CSS"
    ],
    "top": true
  },
  "headers": [],
  "relativePath": "posts/api-examples.md",
  "filePath": "posts/api-examples.md",
  "lastUpdated": 1722708846000
}

Page Frontmatter

{
  "outline": "deep",
  "title": "置顶文章",
  "date": "2021-01-11T00:00:00.000Z",
  "category": [
    "Iconify",
    "Tailwind CSS"
  ],
  "top": true
}

More

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