Skip to content

Рантайм АПИ экзамплс

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:

md
<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": "Home",
      "link": "/"
    },
    {
      "text": "Get Started",
      "link": "/get-started"
    },
    {
      "text": "Live Preview",
      "link": "https://kaede-basement.github.io/kaede/"
    }
  ],
  "sidebar": [
    {
      "text": "For Users",
      "items": [
        {
          "text": "Get Started",
          "link": "/get-started"
        }
      ]
    },
    {
      "text": "Architecture / Design",
      "items": [
        {
          "text": "Project Requirements",
          "link": "/design/project-requirements"
        },
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        }
      ]
    },
    {
      "text": "Technical",
      "items": [
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/kaede-basement/docs"
    }
  ]
}

Page Data

{
  "title": "Рантайм АПИ экзамплс",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "ru/api-examples.md",
  "filePath": "ru/api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

Vue

The count is: 0

More

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