API 示例

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

主要的 useData() API 可以用来访问站点、主题和页面的数据：

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

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

结果

主题数据

{
  "logo": "/favicon.png",
  "search": {
    "provider": "local",
    "options": {
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "displayDetails": "显示详情",
          "resetButtonTitle": "重置搜索",
          "backButtonTitle": "关闭",
          "noResultsText": "没有找到相关结果",
          "footer": {
            "selectText": "选择",
            "selectKeyAriaLabel": "回车",
            "navigateText": "切换",
            "navigateUpKeyAriaLabel": "上箭头",
            "navigateDownKeyAriaLabel": "下箭头",
            "closeText": "关闭",
            "closeKeyAriaLabel": "Esc"
          }
        }
      }
    }
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/PersonalViolet/violet-agents"
    }
  ],
  "footer": {
    "message": "基于 MIT 许可发布 <br/> <a href=\"https://beian.miit.gov.cn/\" target=\"_blank\" rel=\"noopener noreferrer\">粤ICP备2026080692号</a>",
    "copyright": "Copyright © 2024 Violet Agents"
  },
  "lastUpdated": {
    "text": "最后更新于"
  },
  "nav": [
    {
      "text": "文档",
      "link": "/docs/start/install"
    },
    {
      "text": "博客",
      "link": "/blog/markdown"
    }
  ],
  "sidebar": {
    "/docs/": [
      {
        "text": "开始使用",
        "collapsed": false,
        "items": [
          {
            "text": "安装",
            "link": "/docs/start/install"
          },
          {
            "text": "快速开始",
            "link": "/docs/start/quick-start"
          },
          {
            "text": "项目介绍",
            "link": "/docs/start/introduction"
          }
        ]
      },
      {
        "text": "教程",
        "collapsed": false,
        "items": [
          {
            "text": "Agents 智能体",
            "link": "/docs/tutorial/agents"
          },
          {
            "text": "llm 大语言模型",
            "link": "/docs/tutorial/llm"
          },
          {
            "text": "Tools 工具",
            "link": "/docs/tutorial/tools"
          },
          {
            "text": "hooks 钩子",
            "link": "/docs/tutorial/hooks"
          },
          {
            "text": "Message类",
            "link": "/docs/tutorial/message"
          }
        ]
      }
    ],
    "/blog/": [
      {
        "text": "博客",
        "collapsed": false,
        "items": [
          {
            "text": "Markdown 示例",
            "link": "/blog/markdown"
          },
          {
            "text": "API 示例",
            "link": "/blog/api"
          }
        ]
      }
    ],
    "/": []
  },
  "outline": {
    "label": "本页目录",
    "level": [
      2,
      3
    ]
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "darkModeSwitchLabel": "主题切换",
  "sidebarMenuLabel": "菜单",
  "returnToTopLabel": "回到顶部"
}

页面数据

{
  "title": "API 示例",
  "description": "",
  "frontmatter": {},
  "headers": [],
  "relativePath": "blog/api.md",
  "filePath": "blog/api.md",
  "lastUpdated": 1783870309000
}

页面 Frontmatter

{}

更多

查看 VitePress 运行时 API 文档了解更多。