Skip to content

Latest commit

 

History

History
255 lines (181 loc) · 9.28 KB

mintlify-reference.md

File metadata and controls

255 lines (181 loc) · 9.28 KB

Справочник компонентов Mintlify

Полная документация Mintlify доступна по ссылке: https://www.mintlify.com/docs/llms.txt

docs.json

  • Используйте схему docs.json при создании файла конфигурации и настройке навигации по сайту
  • Если какие-либо документы были удалены из папки /docs, убедитесь, что реализовано перенаправление

Компоненты Callout

Используйте их умеренно - только для выделения информации, которую легко пропустить при беглом просмотре страницы

Примечание - Дополнительная полезная информация

Дополнительная информация, которая поддерживает основной контент, не прерывая поток

Совет - Лучшие практики и профессиональные советы

Экспертные рекомендации, сокращения или лучшие практики, которые повышают успех пользователя

Предупреждение - Важные предостережения

Важная информация о потенциальных проблемах, несовместимых изменениях и действиях, которые могут привести к потере данных

Информация - Нейтральная контекстная информация

Фоновая информация, контекст или нейтральные объявления

Галочка - Подтверждения успеха

Положительные подтверждения, успешные завершения или индикаторы достижений

Компоненты кода

Code group с несколькими языками

Пример code group:

```javascript Node.js const response = await fetch('/api/endpoint', { headers: { Authorization: `Bearer ${apiKey}` } }); ``` 
import requests
response = requests.get('/api/endpoint', 
  headers={'Authorization': f'Bearer {api_key}'})
curl -X GET '/api/endpoint' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Структурные компоненты

Шаги для процедур

Пример пошаговых инструкций:

Выполните `npm install` для установки необходимых пакетов. Создайте файл `.env` с вашими API-учетными данными.

Вкладки для альтернативного контента

Пример контента с вкладками:

```bash brew install node npm install -g package-name ```

Accordions для сворачиваемого контента

Пример групп аккордеонов:

- **Firewall blocking**: Ensure ports 80 and 443 are open - **Proxy configuration**: Set HTTP_PROXY environment variable - **DNS resolution**: Try using 8.8.8.8 as DNS server ```javascript const config = { performance: { cache: true, timeout: 30000 }, security: { encryption: 'AES-256' } }; ```

Карточки и колонки для акцентирования информации

Пример карточек и групп карточек:

Пошаговое руководство - от установки до первого вызова API менее чем за 10 минут Узнайте, как аутентифицировать запросы с помощью API-ключей или токенов JWT Поймите, как работают лимиты запросов и как соблюдать лучшие практики при большом объёме трафика

Компоненты документации API

Поля параметров

Пример описания параметров:

Уникальный идентификатор пользователя. Должен соответствовать формату UUID v4 Адрес электронной почты пользователя. Должен быть действительным и уникальным в системе Максимальное количество возвращаемых результатов. Диапазон: 1–100 Токен типа Bearer для аутентификации в API. Формат: `Bearer YOUR_API_KEY`

Поля ответа

Пример описания полей ответа:

Уникальный идентификатор, присвоенный вновь созданному пользователю Отметка времени в формате ISO 8601, когда пользователь был создан Список строк разрешений, назначенных данному пользователю

Разворачиваемые вложенные поля

Пример описания вложенных полей:

Полный объект пользователя со всеми связанными данными Информация профиля пользователя, включая личные данные Имя пользователя, указанное при регистрации. 
<ResponseField name="avatar_url" type="string | null">
URL изображения профиля пользователя. Возвращает null, если аватар не установлен
</ResponseField>

Медиа и расширенные компоненты

Рамки для изображений

Все изображения следует помещать в рамки:

Main dashboard showing analytics overview

Analytics dashboard with charts

Видео

Используйте HTML-элемент video для видео, размещённого на вашем сервере:

<video controls className="w-full aspect-video rounded-xl" src="link-to-your-video.com"

Для вставки видео с YouTube используйте элемент iframe:

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/4KzFe50RQkQ" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen ></iframe>

Подсказки

Пример использования всплывающих подсказок:

API

Обновления

Используйте компонент обновлений для описания изменений

Новые возможности

  • Добавлена функция массового импорта пользователей
  • Улучшены сообщения об ошибках - теперь они содержат полезные рекомендации

Исправления ошибок

  • Исправлена проблема с пагинацией при работе с большими наборами данных
  • Решена проблема тайм-аута при аутентификации