运行时 API 示例

本页演示了 VitePress 提供的一些运行时 API 的用法。

主的 useData() API 可用于访问当前页面的站点、主题和页面数据。它适用于 .md 和 .vue 文件：

<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>

结果

主题数据

{
  "nav": [
    {
      "text": "首页",
      "link": "/zh-cn"
    },
    {
      "text": "示例",
      "link": "/zh-cn/markdown-examples"
    }
  ],
  "sidebar": [
    {
      "text": "示例",
      "items": [
        {
          "text": "Markdown 示例",
          "link": "/zh-cn/markdown-examples"
        },
        {
          "text": "运行时 API 示例",
          "link": "/zh-cn/api-examples"
        }
      ]
    }
  ],
  "search": {
    "options": {
      "placeholder": "搜索文档",
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "searchBox": {
            "clearButtonTitle": "清除查询条件",
            "clearButtonAriaLabel": "清除查询条件",
            "closeButtonText": "关闭",
            "closeButtonAriaLabel": "关闭",
            "placeholderText": "搜索文档",
            "placeholderTextAskAi": "向 AI 提问：",
            "placeholderTextAskAiStreaming": "回答中...",
            "searchInputLabel": "搜索",
            "backToKeywordSearchButtonText": "返回关键字搜索",
            "backToKeywordSearchButtonAriaLabel": "返回关键字搜索"
          },
          "startScreen": {
            "recentSearchesTitle": "搜索历史",
            "noRecentSearchesText": "没有搜索历史",
            "saveRecentSearchButtonTitle": "保存至搜索历史",
            "removeRecentSearchButtonTitle": "从搜索历史中移除",
            "favoriteSearchesTitle": "收藏",
            "removeFavoriteSearchButtonTitle": "从收藏中移除",
            "recentConversationsTitle": "最近的对话",
            "removeRecentConversationButtonTitle": "从历史记录中删除对话"
          },
          "errorScreen": {
            "titleText": "无法获取结果",
            "helpText": "你可能需要检查你的网络连接"
          },
          "noResultsScreen": {
            "noResultsText": "无法找到相关结果",
            "suggestedQueryText": "你可以尝试查询",
            "reportMissingResultsText": "你认为该查询应该有结果？",
            "reportMissingResultsLinkText": "点击反馈"
          },
          "resultsScreen": {
            "askAiPlaceholder": "向 AI 提问： "
          },
          "askAiScreen": {
            "disclaimerText": "答案由 AI 生成，可能不准确，请自行验证。",
            "relatedSourcesText": "相关来源",
            "thinkingText": "思考中...",
            "copyButtonText": "复制",
            "copyButtonCopiedText": "已复制！",
            "copyButtonTitle": "复制",
            "likeButtonTitle": "赞",
            "dislikeButtonTitle": "踩",
            "thanksForFeedbackText": "感谢你的反馈！",
            "preToolCallText": "搜索中...",
            "duringToolCallText": "搜索 ",
            "afterToolCallText": "已搜索",
            "aggregatedToolCallText": "已搜索"
          },
          "footer": {
            "selectText": "选择",
            "submitQuestionText": "提交问题",
            "selectKeyAriaLabel": "Enter 键",
            "navigateText": "切换",
            "navigateUpKeyAriaLabel": "向上箭头",
            "navigateDownKeyAriaLabel": "向下箭头",
            "closeText": "关闭",
            "backToSearchText": "返回搜索",
            "closeKeyAriaLabel": "Esc 键",
            "poweredByText": "搜索提供者"
          }
        }
      },
      "appId": "UIEJ43Y5BA",
      "apiKey": "18dc92dd11264dd06ac232d42ec0bd09",
      "indexName": "documentation"
    },
    "provider": "algolia"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "outline": {
    "label": "页面导航"
  },
  "lastUpdated": {
    "text": "最后更新于"
  },
  "notFound": {
    "title": "页面未找到",
    "quote": "但如果你不改变方向，并且继续寻找，你可能最终会到达你所前往的地方。",
    "linkLabel": "前往首页",
    "linkText": "带我回首页"
  },
  "langMenuLabel": "多语言",
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "darkModeSwitchLabel": "主题",
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式",
  "skipToContentLabel": "跳转到内容",
  "logo": "./favicon.svg",
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/sugarscat/docs"
    }
  ]
}

页面数据

{
  "title": "运行时 API 示例",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "zh-cn/api-examples.md",
  "filePath": "zh-cn/api-examples.md",
  "lastUpdated": 1754730230000
}

页面 Frontmatter

{
  "outline": "deep"
}

更多

请查看运行时 API 完整列表的文档。