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

{
  "search": {
    "provider": "local",
    "options": {
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "noResultsText": "无法找到相关结果",
          "resetButtonTitle": "清除查询条件",
          "footer": {
            "selectText": "选择",
            "navigateText": "切换",
            "closeText": "关闭"
          }
        }
      }
    }
  },
  "nav": [
    {
      "text": "主页",
      "link": "/"
    },
    {
      "text": "Vue",
      "link": "/vue/base/hellovue"
    },
    {
      "text": "日语",
      "link": "/jpeden/jpeden"
    }
  ],
  "sidebar": {
    "/vue": [
      {
        "text": "基础",
        "items": [
          {
            "text": "Hello Vue",
            "link": "/vue/base/hellovue"
          },
          {
            "text": "组件",
            "link": "/vue/base/components"
          },
          {
            "text": "模块化开发",
            "link": "/vue/base/modular-development"
          }
        ]
      }
    ],
    "/jpeden/grammar": [
      {
        "text": "初级语法",
        "collapsed": true,
        "items": [
          {
            "text": "动词词形变化",
            "link": "/jpeden/grammar/verbinflection"
          },
          {
            "text": "给与与获取",
            "link": "/jpeden/grammar/giving-obtaining"
          },
          {
            "text": "转折连词",
            "link": "/jpeden/grammar/adversative"
          },
          {
            "text": "条件表达",
            "link": "/jpeden/grammar/condition"
          },
          {
            "text": "原因目的",
            "link": "/jpeden/grammar/reasonandpurpose"
          },
          {
            "text": "推测传闻",
            "link": "/jpeden/grammar/speculative"
          },
          {
            "text": "形容词与名词",
            "link": "/jpeden/grammar/adjandnouns"
          },
          {
            "text": "なります、します",
            "link": "/jpeden/grammar/nariandshi"
          },
          {
            "text": "て形用法",
            "link": "/jpeden/grammar/teusage"
          },
          {
            "text": "疑问词常用接续",
            "link": "/jpeden/grammar/whword"
          },
          {
            "text": "表示只有",
            "link": "/jpeden/grammar/only"
          },
          {
            "text": "动词ます形后续的几个特殊动词",
            "link": "/jpeden/grammar/verbspec"
          },
          {
            "text": "常用意志形表达方式",
            "link": "/jpeden/grammar/willusage"
          },
          {
            "text": "并列，列举",
            "link": "/jpeden/grammar/juxtaposition"
          },
          {
            "text": "ところ的用法",
            "link": "/jpeden/grammar/tokorousage"
          },
          {
            "text": "形容词的用法",
            "link": "/jpeden/grammar/adjusage"
          },
          {
            "text": "自动词，他动词",
            "link": "/jpeden/grammar/intransitiveverb-iransitiveverb"
          },
          {
            "text": "自谦与尊他",
            "link": "/jpeden/grammar/humilityandrespect"
          },
          {
            "text": "其他",
            "link": "/jpeden/grammar/other"
          },
          {
            "text": "常用词汇",
            "link": "/jpeden/grammar/commonvocabulary1"
          },
          {
            "text": "常用词汇-拟声词",
            "link": "/jpeden/grammar/commonvocabulary2"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "lastUpdated": {
    "text": "最近更新于",
    "formatOptions": {
      "dateStyle": "short",
      "timeStyle": "medium"
    }
  },
  "darkModeSwitchLabel": "主题",
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式",
  "sidebarMenuLabel": "菜单",
  "returnToTopLabel": "回到顶部",
  "langMenuLabel": "多语言",
  "outline": {
    "level": "deep",
    "label": "当前页"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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