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": "Overview",
      "link": "/overview/what-is-dc-core"
    },
    {
      "text": "Architecture",
      "link": "/architecture/overview"
    },
    {
      "text": "Platform",
      "link": "/platform/central"
    },
    {
      "text": "Build",
      "link": "/build/getting-started"
    }
  ],
  "sidebar": [
    {
      "text": "Overview",
      "items": [
        {
          "text": "What is DC CORE",
          "link": "/overview/what-is-dc-core"
        },
        {
          "text": "Core Principles",
          "link": "/overview/core-principles"
        },
        {
          "text": "Why No Open Ports",
          "link": "/overview/why-no-ports"
        },
        {
          "text": "Comparison vs Traditional Infra",
          "link": "/overview/comparison"
        }
      ]
    },
    {
      "text": "Networking",
      "items": [
        {
          "text": "HTTP → Mesh Flow",
          "link": "/networking/http-to-mesh"
        },
        {
          "text": "Domain Routing & SNI",
          "link": "/networking/domain-routing"
        },
        {
          "text": "Port Forwarding",
          "link": "/networking/port-forwarding"
        }
      ]
    },
    {
      "text": "Build & Deploy",
      "items": [
        {
          "text": "Getting Started (Linux)",
          "link": "/build/getting-started-linux"
        },
        {
          "text": "Getting Started (Windows)",
          "link": "/build/getting-started-windows"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/dccore"
    }
  ]
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "architecture/overview.md",
  "filePath": "architecture/overview.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

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