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": "/"
    },
    {
      "text": "Текст договора",
      "link": "/oferta"
    }
  ],
  "sidebar": [
    {
      "text": "Договор",
      "items": [
        {
          "text": "Содержание",
          "link": "/oferta"
        },
        {
          "text": "Термины",
          "link": "/trms"
        },
        {
          "text": "Общие положения",
          "link": "/general"
        },
        {
          "text": "Предмет договора",
          "link": "/agreement"
        }
      ]
    },
    {
      "text": "Обязанности сторон",
      "items": [
        {
          "text": "Обязанности исполнителя",
          "link": "/obligations"
        },
        {
          "text": "Гарантии исполнителя",
          "link": "/garant"
        },
        {
          "text": "Обязанности Архи-Про",
          "link": "/obligations-arhi-pro"
        },
        {
          "text": "Гарантии Сторон",
          "link": "/garant-it"
        }
      ]
    },
    {
      "text": "Порядок",
      "items": [
        {
          "text": "Порядок обмена актами-отчетами",
          "link": "/acts"
        },
        {
          "text": "Bознаграждение и порядок его выплаты",
          "link": "/rules"
        }
      ]
    },
    {
      "text": "Конфиденциальность",
      "items": [
        {
          "text": "Условия конфиденциальности",
          "link": "/conf"
        }
      ]
    },
    {
      "text": "Ответственность",
      "items": [
        {
          "text": "Ответственность сторон",
          "link": "/reply"
        },
        {
          "text": "Основания освобождения от ответственности",
          "link": "/no-reply"
        }
      ]
    },
    {
      "text": "Срок",
      "items": [
        {
          "text": "Срок действия договора",
          "link": "/period"
        }
      ]
    },
    {
      "text": "Приложения",
      "items": [
        {
          "text": "Содержание",
          "link": "/oferta-part"
        }
      ]
    }
  ],
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/ink-kin/arhi-pro-agent-oferta.git"
    }
  ],
  "sitemap": {
    "hostname": "https://example.com"
  }
}

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.