Параметры заголовка
Управляйте тем, что отображается в верхней панели навигации вашего сайта документации.
Настройки#
| Настройка | Что она делает |
|---|---|
| Показывать заголовок | Показывать или скрывать всю верхнюю панель навигации |
| Ссылки в заголовке | Пользовательские текстовые ссылки в навигации заголовка |
| Социальные ссылки | Иконки ссылок для GitHub, Twitter, Discord |
| Переключатель темы в заголовке | Показывать переключатель светлой/темной темы в заголовке |
| Выбор языка в заголовке | Показывать переключатель языка в заголовке |
| Кнопка поиска в заголовке | Показывать иконку/кнопку поиска в заголовке |
Как настроить#
- Откройте ваш сайт документации.
- Плавающий виджет → Дизайн → вкладка Заголовок.
- Заполните поля и переключите опции.
- Сохраните.
Ссылки в заголовках#
Добавьте пользовательские навигационные ссылки, которые отображаются в верхней панели — полезно для ссылок на ваш продукт, блог, журнал изменений или поддержку.
Формат: Каждая ссылка имеет подпись и URL.
Пример:
| Подпись | URL |
|---|---|
| Продукт | https://yourapp.com |
| Журнал изменений | https://yourapp.com/changelog |
| Поддержка | https://yourapp.com/support |
Социальные ссылки#
Добавьте иконки ссылок для вашего сообщества и присутствия в социальных сетях.
Поддерживаемые платформы:
- GitHub — ссылки на ваш репозиторий или организацию
- Twitter / X — ссылки на ваш профиль Twitter
- Discord — ссылки на ваш сервер сообщества
Социальные ссылки отображаются в виде небольших иконок в заголовке. Они помогают читателям найти ваше сообщество, не засоряя навигацию текстовыми ссылками.
Тема & Язык в Шапке#
Вы можете разместить переключатель темы и переключатель языка в шапке вместо (или в дополнение к) боковой панели.
Рекомендация: Выберите одно местоположение для каждого элемента управления, чтобы избежать дублирования.
- Размещение в шапке: более заметно, меньшая глубина кликов для новых посетителей.
- Размещение в боковой панели: экономит место в шапке, лучше для плотных шапок.
Опции боковой панели → Опции оформления →
Скрытие заголовка#
Установка параметра Показывать заголовок в положение «выкл» удаляет всю верхнюю панель навигации.
Делайте это только для сценариев внедрения или киосков, где ваша документация встроена в другой продукт. Для автономных сайтов документации всегда оставляйте заголовок видимым.
Разрабатывайте навигацию, которая направляет ваших читателей. Подключите свой репозиторий GitHub →