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.png",
  "socialLinks": [
    {
      "icon": "whatsapp",
      "link": "https://wa.me/79833146833?text=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82!%20%F0%9F%91%8B%20%D0%9F%D0%B8%D1%88%D1%83%20%D1%81%20%D1%81%D0%B0%D0%B9%D1%82%D0%B0%20%D0%92%D0%B8%D0%BA%D0%B8"
    },
    {
      "icon": "telegram",
      "link": "https://t.me/+79833146833"
    }
  ],
  "editLink": {
    "pattern": "https://git.cdev.su/confignsk/vitepress/src/branch/main/:path",
    "text": "Редактировать эту страницу на CDGITea"
  },
  "nav": [
    {
      "text": "Сайт ConfigDEV",
      "link": "https://configdev.ru"
    },
    {
      "text": "Примеры",
      "link": "/case/"
    },
    {
      "text": "Документация",
      "link": "/docs/"
    },
    {
      "text": "GIT",
      "link": "https://git.cdev.su"
    },
    {
      "text": "Техподдержка",
      "link": "https://help.cdev.su"
    }
  ],
  "search": {
    "provider": "local",
    "options": {
      "locales": {
        "root": {
          "translations": {
            "button": {
              "buttonText": "Поиск",
              "buttonAriaLabel": "Поиск"
            },
            "modal": {
              "displayDetails": "Отобразить подробный список",
              "resetButtonTitle": "Сбросить поиск",
              "backButtonTitle": "Закрыть поиск",
              "noResultsText": "Нет результатов по запросу",
              "footer": {
                "selectText": "выбрать",
                "selectKeyAriaLabel": "выбрать",
                "navigateText": "перейти",
                "navigateUpKeyAriaLabel": "стрелка вверх",
                "navigateDownKeyAriaLabel": "стрелка вниз",
                "closeText": "закрыть",
                "closeKeyAriaLabel": "esc"
              }
            }
          }
        }
      }
    }
  },
  "footer": {
    "message": "Опубликовано под лицензией MIT.",
    "copyright": "© 2025 – Confignsk aka Max Moiseev"
  },
  "docFooter": {
    "prev": "Предыдущая страница",
    "next": "Следующая страница"
  },
  "darkModeSwitchTitle": "Переключить в темный режим",
  "lightModeSwitchTitle": "Переключить в светлый режим",
  "darkModeSwitchLabel": "Темный режим",
  "sidebarMenuLabel": "Навигация",
  "returnToTopLabel": "Наверх",
  "outline": 2,
  "outlineTitle": "Содержание",
  "sidebar": {
    "/docs/": {
      "base": "/docs/",
      "items": [
        {
          "text": "Документация",
          "items": [
            {
              "text": "Знания 1С",
              "items": [
                {
                  "text": "Базы всем пользователям",
                  "link": "1c/base-all-users"
                },
                {
                  "text": "Классификаторы 1С",
                  "link": "1c/classifiers"
                },
                {
                  "text": "Ошибки работы почты в 1с",
                  "link": "1c/fail-mail"
                },
                {
                  "text": "Полезные советы по программе 1С",
                  "link": "1c/misc"
                },
                {
                  "text": "Разработка печатных форм (УФ)",
                  "link": "1c/pf"
                }
              ],
              "collapsed": true
            },
            {
              "text": "ALT Linux",
              "items": [
                {
                  "text": "Установка 1С",
                  "link": "altlinux/1c-install-alt-gnome"
                },
                {
                  "text": "О ALT Linux",
                  "link": "altlinux/about-alt"
                },
                {
                  "text": "Внешний вид Альт Рабочая станция",
                  "link": "altlinux/alt-theme-custom"
                },
                {
                  "text": "Полезные команды ALT Linux",
                  "link": "altlinux/commands"
                },
                {
                  "text": "Облако Nextcloud",
                  "link": "altlinux/nextcloud-client"
                },
                {
                  "text": "Запуск сервера Nextcloud на Alt Linux JeOS",
                  "link": "altlinux/nextcloud-server"
                }
              ],
              "collapsed": true
            },
            {
              "text": "Bitrix Framework",
              "items": [
                {
                  "text": "Разработка",
                  "items": [
                    {
                      "text": "Установка свойств физ страниц",
                      "link": "bitrix/dev/add-prop-static-page"
                    },
                    {
                      "text": "CAPTCHA Bitrix",
                      "link": "bitrix/dev/captcha-bitrix"
                    },
                    {
                      "text": "Wizard с главной",
                      "link": "bitrix/dev/start-wizard-main"
                    }
                  ],
                  "collapsed": true
                },
                {
                  "text": "Полезные советы Bitrix",
                  "link": "bitrix/misc"
                },
                {
                  "text": "Модули",
                  "items": [
                    {
                      "text": "Модуль cdev.help",
                      "items": [
                        {
                          "text": "about",
                          "link": "bitrix/modules/cdev-help/about"
                        },
                        {
                          "text": "Вспомогательный класс CdevUtils",
                          "link": "bitrix/modules/cdev-help/cdev-utils"
                        }
                      ],
                      "collapsed": true
                    }
                  ],
                  "collapsed": true
                }
              ],
              "collapsed": true
            },
            {
              "text": "HESK Support",
              "items": [
                {
                  "text": "Установка модуля",
                  "link": "hesk/module-install"
                },
                {
                  "text": "Модуль для HESK",
                  "link": "hesk/module"
                },
                {
                  "text": "Редактор HESK (Tinymce)",
                  "link": "hesk/tinymce"
                }
              ],
              "collapsed": true
            },
            {
              "text": "Nextcloud",
              "items": [
                {
                  "text": "Запуск сервера Nextcloud на Alt Server P11",
                  "link": "nextcloud/start-nextcloud-alt-server-p11"
                }
              ],
              "collapsed": true
            },
            {
              "text": "Разные полезные знания",
              "items": [
                {
                  "text": "Примеры VitePress",
                  "items": [
                    {
                      "text": "api-examples",
                      "link": "other/examples/api-examples"
                    },
                    {
                      "text": "markdown-examples",
                      "link": "other/examples/markdown-examples"
                    },
                    {
                      "text": "Настройки сайдбар",
                      "link": "other/examples/vp-sidebar"
                    }
                  ],
                  "collapsed": true
                },
                {
                  "text": "GIT - Советы",
                  "link": "other/git"
                },
                {
                  "text": "Libre Office",
                  "items": [
                    {
                      "text": "Libre Writer - Советы",
                      "link": "other/libreoffice/writer"
                    }
                  ],
                  "collapsed": true
                },
                {
                  "text": "links",
                  "link": "other/links"
                },
                {
                  "text": "Заметки по линукс",
                  "link": "other/linux-notes"
                },
                {
                  "text": "Midnight Commander",
                  "link": "other/midnight-commander"
                },
                {
                  "text": "Полезности",
                  "link": "other/other"
                },
                {
                  "text": "Настройки сайдбар",
                  "link": "other/vp-sidebar"
                }
              ],
              "collapsed": true
            },
            {
              "text": "Perfex CRM",
              "items": [
                {
                  "text": "Создание пунктов меню с помощью модуля",
                  "link": "perfexcrm/ceate-menu-items-module"
                },
                {
                  "text": "Создание модуля в PerfexCRM",
                  "link": "perfexcrm/create-module"
                }
              ],
              "collapsed": true
            },
            {
              "text": "Серверы",
              "items": [
                {
                  "text": "BrainyCP",
                  "items": [
                    {
                      "text": "Смена домена сайта",
                      "link": "servers/brainycp/change-domen-site"
                    }
                  ],
                  "collapsed": true
                },
                {
                  "text": "Windows",
                  "items": [
                    {
                      "text": "Полезное",
                      "link": "servers/windows/misc"
                    },
                    {
                      "text": "Запуск ТС 2016 / 2019",
                      "link": "servers/windows/start-server"
                    }
                  ],
                  "collapsed": true
                }
              ],
              "collapsed": true
            }
          ],
          "collapsed": false
        }
      ]
    },
    "/case/": {
      "base": "/case/",
      "items": [
        {
          "text": "Опыт",
          "items": []
        }
      ]
    }
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "docs/other/examples/api-examples.md",
  "filePath": "docs/other/examples/api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

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