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

{
  "siteTitle": "LDG<code class=\"VPBadge tip\">v1.0.0</code>",
  "logo": {
    "src": "/Luke-avatar.png",
    "alt": "Luke Jiang"
  },
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "日志",
      "link": "/note"
    },
    {
      "text": "领域",
      "link": "/area"
    },
    {
      "text": "<Badge type=\"warning\" text=\"beta\" />",
      "link": "/reference"
    }
  ],
  "sidebar": {
    "/": [],
    "/note/": [
      {
        "index": "level1_dir1",
        "text": "level1_dir1",
        "collapsed": false,
        "items": [
          {
            "index": "随机文章标题1",
            "text": "随机文章标题1",
            "link": "/note/level1_dir1/file1"
          },
          {
            "index": "随机文章标题2",
            "text": "随机文章标题2",
            "link": "/note/level1_dir1/file2"
          },
          {
            "index": "随机文章标题3",
            "text": "随机文章标题3",
            "link": "/note/level1_dir1/file3"
          }
        ]
      },
      {
        "index": "level1_dir2",
        "text": "level1_dir2",
        "collapsed": false,
        "items": [
          {
            "index": "随机文章标题4",
            "text": "随机文章标题4",
            "link": "/note/level1_dir2/file1"
          },
          {
            "index": "随机文章标题5",
            "text": "随机文章标题5",
            "link": "/note/level1_dir2/file2"
          },
          {
            "index": "随机文章标题6",
            "text": "随机文章标题6",
            "link": "/note/level1_dir2/file3"
          }
        ]
      }
    ],
    "/area/": [
      {
        "index": "level1_dir1",
        "text": "level1_dir1",
        "collapsed": false,
        "items": [
          {
            "index": "随机文章标题7",
            "text": "随机文章标题7",
            "link": "/area/level1_dir1/file1"
          },
          {
            "index": "随机文章标题8",
            "text": "随机文章标题8",
            "link": "/area/level1_dir1/file2"
          },
          {
            "index": "随机文章标题9",
            "text": "随机文章标题9",
            "link": "/area/level1_dir1/file3"
          }
        ]
      },
      {
        "index": "level1_dir2",
        "text": "level1_dir2",
        "collapsed": false,
        "items": [
          {
            "index": "随机文章标题10",
            "text": "随机文章标题10",
            "link": "/area/level1_dir2/file1"
          },
          {
            "index": "随机文章标题11",
            "text": "随机文章标题11",
            "link": "/area/level1_dir2/file2"
          },
          {
            "index": "随机文章标题12",
            "text": "随机文章标题12",
            "link": "/area/level1_dir2/file3"
          }
        ]
      },
      {
        "index": "Tech",
        "text": "Tech",
        "collapsed": false,
        "items": [
          {
            "index": "API 示例",
            "text": "API 示例",
            "link": "/area/Tech/api-examples"
          },
          {
            "index": "Markdown Extension Examples",
            "text": "Markdown Extension Examples",
            "link": "/area/Tech/markdown-examples"
          }
        ]
      }
    ]
  },
  "outline": "deep",
  "outlineTitle": "页面导航",
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/Cretu"
    },
    {
      "icon": "twitter",
      "link": "https://twitter.com/Cretu"
    },
    {
      "icon": "wechat",
      "link": "https://chat.vitejs.dev/Cretu"
    },
    {
      "icon": "tiktok",
      "link": "https://chat.vitejs.dev/Cretu"
    },
    {
      "icon": "linkedin",
      "link": "https://chat.vitejs.dev/Cretu"
    }
  ],
  "footer": {
    "message": "自由共享 · 保留署名",
    "copyright": "Copyright © 2025 Luke Jiang"
  },
  "docFooter": {
    "prev": "上一页",
    "next": "下一页"
  },
  "lastUpdated": {
    "text": "最后更新于"
  },
  "notFound": {
    "title": "页面未找到",
    "quote": "但如果你不改变方向，并且继续寻找，你可能最终会到达你所前往的地方。",
    "linkLabel": "前往首页",
    "linkText": "带我回首页"
  },
  "returnToTopLabel": "回到顶部",
  "sidebarMenuLabel": "菜单",
  "darkModeSwitchLabel": "主题",
  "lightModeSwitchTitle": "切换到浅色模式",
  "darkModeSwitchTitle": "切换到深色模式",
  "skipToContentLabel": "跳转到内容",
  "search": {
    "provider": "local",
    "options": {
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "noResultsText": "无法找到相关结果",
          "resetButtonTitle": "清除查询条件",
          "footer": {
            "selectText": "选择",
            "navigateText": "切换",
            "closeText": "取消"
          }
        }
      }
    }
  }
}

Page Data

{
  "title": "API 示例",
  "description": "",
  "frontmatter": {
    "title": "API 示例",
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "area/Tech/api-examples.md",
  "filePath": "area/Tech/api-examples.md"
}

Page Frontmatter

{
  "title": "API 示例",
  "outline": "deep"
}

More

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