Эта документация построена на платформе Mintlify. Все страницы пишутся в формате MDX — это Markdown с поддержкой React-компонентов.
Структура страницы
Каждая страница начинается с frontmatter — метаданных в формате YAML между---:
Основные поля frontmatter
Основные поля frontmatter
| Поле | Описание |
|---|---|
title | Заголовок страницы (обязательно) |
description | Описание для SEO и превью |
sidebarTitle | Короткий заголовок для боковой панели |
icon | Иконка из Font Awesome или Lucide |
tag | Метка рядом с заголовком (например, “NEW”) |
Форматирование текста
Базовый синтаксис Markdown
inline код
Ссылка

Заголовки
Используйте заголовки для структурирования контента. Они автоматически появляются в оглавлении справа.Списки
- Маркированный список
- Ещё один пункт
- Вложенный пункт
- Нумерованный список
- Второй пункт
- Третий пункт
Компоненты
Компоненты — это готовые блоки для оформления контента. Подробнее: Mintlify ComponentsCallouts (выноски)
Используйте для привлечения внимания к важной информации:Информационная заметка
Accordion (аккордеон)
Сворачиваемые секции для длинного контента:Первый вопрос
Первый вопрос
Ответ на первый вопрос
Второй вопрос
Второй вопрос
Ответ на второй вопрос
Cards (карточки)
Для навигации и выделения разделов:Steps (шаги)
Для пошаговых инструкций:Tabs (вкладки)
Для альтернативного контента:- Вариант A
- Вариант B
Контент варианта A
Блоки кода
Простой блок кода
Используйте тройные обратные кавычки с указанием языка:Группа кода
Для примеров на разных языках:Изображения
Базовое добавление

С рамкой (Frame)

Лучшие практики
Структура
- Один H1 на страницу (title в frontmatter)
- Логичная иерархия заголовков
- Короткие абзацы
Стиль
- Пишите от второго лица (“вы”)
- Избегайте сложных конструкций
- Используйте активный залог
Ссылки
- Описательный текст ссылок
- Относительные пути для внутренних ссылок
- Проверяйте битые ссылки
Код
- Всегда указывайте язык
- Тестируйте примеры
- Добавляйте комментарии
