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

{
  "nav": [
    {
      "text": "己维智能主页",
      "link": "https://www.jiweibz.com"
    },
    {
      "text": "八字知识库主页",
      "link": "/"
    },
    {
      "text": "己维排盘主页",
      "link": "https://bazi.jiweibz.com"
    }
  ],
  "footer": {
    "message": "【免责声明】本站所有内容（含八字排盘工具、付费解锁内容、文章、图表）仅为中国传统民俗文化、阴阳五行、易学典籍的学术研究与文化科普，属于传统文化研究参考工具，不具备科学依据，不构成任何人生决策、投资、婚恋、健康、学业、事业、运势预测及趋吉避凶指导。",
    "copyright": "Copyright © 2026 深圳市己维智能科技有限公司"
  },
  "sidebar": [
    {
      "text": "社会人文",
      "items": [
        {
          "text": "现代女性的命盘该怎么看",
          "link": "/rensheng/woman-bazi-way"
        },
        {
          "text": "中年的压力和困惑如何面对",
          "link": "/rensheng/zhongnian-yali"
        },
        {
          "text": "30+未婚女性：优秀却难遇良缘",
          "link": "/rensheng/woman-late-marriage"
        },
        {
          "text": "从八字理论分析，2026年，哪几类人财运将提升",
          "link": "/advance/2026-money-3-kind-people"
        },
        {
          "text": "2026年财运好的八字，都有这个共同特征（附自查方法）",
          "link": "/rensheng/2026-rich-money-tezhen"
        },
        {
          "text": "2026丙午年桃花运全解析：这三类人即将迎来“正缘”！（附自查方法）",
          "link": "/rensheng/2026-love-chance"
        },
        {
          "text": "2026丙午年婚恋预警：这 3 类八字，请提前做好感情的“防碰撞测试”",
          "link": "/rensheng/2026-love-problem"
        },
        {
          "text": "八字中藏着配偶的信息”",
          "link": "/rensheng/bazi-marriage"
        },
        {
          "text": "人际交往小参考：通过老祖宗的“干支密码”，解读人与人的相处之道”",
          "link": "/rensheng/ganzhi-mima"
        },
        {
          "text": "日常参考：八字排盘帮你了解自身行事风格",
          "link": "/rensheng/know-self-by-bazi"
        },
        {
          "text": "回家还要被妻子数落：中年男人的出路在哪里？",
          "link": "/rensheng/man-40-with-a-bad-wife"
        },
        {
          "text": "人生下半场，学会放过那个曾经笨拙的自己",
          "link": "/rensheng/shihuai-hejie"
        }
      ]
    },
    {
      "text": "八字基础",
      "items": [
        {
          "text": "五行",
          "link": "/bazi-basic/wuxing"
        },
        {
          "text": "天干地支",
          "link": "/bazi-basic/tiangan-dizhi"
        },
        {
          "text": "天干五合",
          "link": "/bazi-basic/tiangan-wuhe"
        },
        {
          "text": "天干冲克",
          "link": "/bazi-basic/tiangan-chongke"
        },
        {
          "text": "十二地支",
          "link": "/bazi-basic/shier-dizhi"
        },
        {
          "text": "地支六冲",
          "link": "/bazi-basic/dizhi-liuchong"
        },
        {
          "text": "地支六合",
          "link": "/bazi-basic/dizhi-liuhe"
        },
        {
          "text": "地支三刑",
          "link": "/bazi-basic/dizhi-sanxing"
        },
        {
          "text": "地支三合三会",
          "link": "/bazi-basic/dizhi-sanhe-sanhui"
        },
        {
          "text": "十神详解",
          "link": "/bazi-basic/shishen"
        },
        {
          "text": "十天干生旺死绝表",
          "link": "/bazi-basic/shitiangan-shengwang-sijue"
        },
        {
          "text": "调候用神表",
          "link": "/bazi-basic/yushi-yongshen-tiaohou"
        }
      ]
    },
    {
      "text": "八字进阶",
      "items": [
        {
          "text": "八字知识科普之：八大格局顺用、逆用的奥秘",
          "link": "/advance/geju-shun-ni"
        },
        {
          "text": "八字知识科普之：女命夫星是用官还是用杀？",
          "link": "/advance/woman-wife-use-guan-sha"
        },
        {
          "text": "八字知识科普之：女命夫星带合的解释",
          "link": "/advance/woman-fuxing-daihe"
        },
        {
          "text": "从子平命理与禄命法角度，分析李小龙的八字",
          "link": "/advance/bruce-lee"
        }
      ]
    },
    {
      "text": "纳音古法",
      "items": [
        {
          "text": "玉照定真经",
          "link": "/bazi-basic/yzdzj"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.