Skip to content

运行示例

本页面演示了 VitePress 提供的一些运行时 API 的使用方法。 主要 useData() API 可用于访问当前页面的网站、主题和页面数据。它在 .md.vue 文件中都有效:

md
<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## 返回结果

### 主题数据
<pre>{{ theme }}</pre>

### 页面数据
<pre>{{ page }}</pre>

### 页面前言
<pre>{{ frontmatter }}</pre>

返回结果

主题数据

{
  "logo": "/favicon.ico",
  "siteTitle": "x-celerator 文档",
  "i18nRouting": true,
  "nav": [
    {
      "text": "首页",
      "link": "/index.md"
    }
  ],
  "sidebar": [
    {
      "text": "用户手册",
      "collapsed": false,
      "items": [
        {
          "text": "操作手册",
          "link": "/zh/userManual/userGuide"
        }
      ]
    },
    {
      "text": "开发者指南",
      "collapsed": false,
      "items": [
        {
          "text": "服务指南",
          "link": "/zh/developerGuide/service"
        }
      ]
    }
  ],
  "footer": {
    "message": "Released under the MIT License.",
    "copyright": "Copyright © 2019-present Evan You"
  },
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "zh": {
          "translations": {
            "button": {
              "buttonText": "搜索文档",
              "buttonAriaLabel": "搜索文档"
            },
            "modal": {
              "noResultsText": "无法找到相关结果",
              "resetButtonTitle": "清除查询条件",
              "footer": {
                "selectText": "选择",
                "navigateText": "切换"
              }
            }
          }
        }
      }
    }
  }
}

页面数据

{
  "title": "运行示例",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "zh/userManual/userGuide.md",
  "filePath": "zh/userManual/userGuide.md"
}

页面前言

{
  "outline": "deep"
}

更多

请查看相关文档 full list of runtime APIs.

Released under the MIT License.