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"
  },
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "参考",
      "link": "/guide/vitepress-start"
    }
  ],
  "sidebar": [
    {
      "text": "vitepress搭建博客",
      "collapsed": true,
      "base": "/guide/",
      "items": [
        {
          "text": "起步",
          "link": "vitepress-start"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    },
    {
      "text": "java ee",
      "collapsed": true,
      "base": "/JavaEE/",
      "items": [
        {
          "text": "java SPI思想",
          "link": "java_spi"
        },
        {
          "text": "java JDBC",
          "link": "java_jdbc"
        }
      ]
    },
    {
      "text": "Servlet",
      "collapsed": true,
      "base": "/servlet/",
      "items": [
        {
          "text": "servlet 快速入门",
          "link": "servlet_one"
        },
        {
          "text": "servlet 生命周期",
          "link": "servlet_two"
        },
        {
          "text": "servlet ",
          "link": "servlet_two"
        }
      ]
    },
    {
      "text": "SpringBoot",
      "collapsed": true,
      "base": "/springboot/",
      "items": [
        {
          "text": "spring-boot日志",
          "link": "spring_boot_log"
        },
        {
          "text": "spring-boot切面",
          "link": "spring_boot_aop"
        },
        {
          "text": "spring-boot异常",
          "link": "spring_boot_exception"
        },
        {
          "text": "spring-boot JDBC",
          "link": "spring_boot_jdbcTemplades"
        },
        {
          "text": "spring-boot Mybatis",
          "link": "spring_boot_mybatis"
        },
        {
          "text": "spring-boot 配置文件",
          "link": "spring_boot_metadate_format"
        },
        {
          "text": "spring-boot 监控及自定义",
          "link": "spring_boot_actuator"
        },
        {
          "text": "spring-boot 图形化监控",
          "link": "spring_boot_admin"
        }
      ]
    },
    {
      "text": "GitLabCICD",
      "collapsed": true,
      "base": "/GitLabCICD/",
      "items": [
        {
          "text": "gitlabcicd基础",
          "link": "gitlabcicd基础"
        }
      ]
    },
    {
      "text": "定时任务",
      "collapsed": true,
      "base": "/xxl-job/",
      "items": [
        {
          "text": "xxl-job_00:基础认识",
          "link": "xxl_job"
        },
        {
          "text": "xxl-job_01:其他功能",
          "link": "xxl_job_01"
        }
      ]
    },
    {
      "text": "linux",
      "collapsed": true,
      "base": "/linux/",
      "items": [
        {
          "text": "nginx_00:基础认识",
          "link": "nginx"
        },
        {
          "text": "nginx_01:配置负载均衡",
          "link": "nginx_01"
        }
      ]
    },
    {
      "text": "c&c++",
      "collapsed": true,
      "base": "/c_cPlus/",
      "items": [
        {
          "text": "c环境搭建",
          "link": "c_one"
        },
        {
          "text": "c其他基础知识",
          "link": "c_other"
        }
      ]
    },
    {
      "text": "微信相关",
      "collapsed": true,
      "base": "/wx/",
      "items": [
        {
          "text": "微信-公众号-网页授权",
          "link": "wx_gzh"
        }
      ]
    },
    {
      "text": "日记-2024",
      "collapsed": true,
      "base": "/day/",
      "items": [
        {
          "text": "2024-09-12",
          "link": "2024-09-12"
        },
        {
          "text": "2024-09-14",
          "link": "2024-09-14"
        },
        {
          "text": "2024-09-19",
          "link": "2024-09-19"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/yfdisme/yfd-blog.git"
    }
  ]
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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