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

{
  "logo": "./logo.svg",
  "nav": [
    {
      "text": "主页",
      "link": "/"
    },
    {
      "text": "编码规范",
      "items": [
        {
          "text": "HTML 编码规范",
          "link": "/coding/html.md"
        },
        {
          "text": "CSS 编码规范",
          "link": "/coding/css.md"
        },
        {
          "text": "JavaScript 编码规范",
          "link": "/coding/javascript.md"
        },
        {
          "text": "Typescript 编码规范",
          "link": "/coding/typescript.md"
        },
        {
          "text": "Node 编码规范",
          "link": "/coding/node.md"
        }
      ]
    },
    {
      "text": "工程规范",
      "items": [
        {
          "text": "Git 规范",
          "link": "/engineering/git.md"
        },
        {
          "text": "文档规范",
          "link": "/engineering/doc.md"
        }
      ]
    }
  ],
  "sidebar": {
    "/coding/": [
      {
        "text": "编码规范",
        "items": [
          {
            "text": "HTML 编码规范",
            "link": "/coding/html.md"
          },
          {
            "text": "CSS 编码规范",
            "link": "/coding/css.md"
          },
          {
            "text": "JavaScript 编码规范",
            "link": "/coding/javascript.md"
          },
          {
            "text": "Typescript 编码规范",
            "link": "/coding/typescript.md"
          },
          {
            "text": "Node 编码规范",
            "link": "/coding/node.md"
          }
        ]
      }
    ],
    "/engineering/": [
      {
        "text": "工程规范",
        "items": [
          {
            "text": "Git 规范",
            "link": "/engineering/git.md"
          },
          {
            "text": "文档规范",
            "link": "/engineering/doc.md"
          }
        ]
      }
    ]
  }
}

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.