Параметры поиска
Настройте, как посетители будут искать вашу документацию.
Настройки#
| Настройка | Где появляется |
|---|---|
| Кнопка поиска | В верхней панели заголовка |
| Поиск в боковой панели | В левой боковой панели |
Как настроить#
Для кнопки поиска в заголовке: Float Widget → Дизайн → вкладка Заголовок → переключить Кнопку поиска.
Для поиска в боковой панели: Float Widget → Дизайн → вкладка Левая боковая панель → переключить Поиск в боковой панели.
Какой использовать?#
Оба варианта доступны, но обычно достаточно включить одно расположение.
| Размещение | Лучше всего подходит для |
|---|---|
| Заголовок | Наиболее заметно для новых посетителей |
| Боковая панель | Опытные пользователи, которые часто пользуются боковой панелью |
Включение обоих работает нормально — это вопрос дизайнерских предпочтений. Если заголовок уже перегружен ссылками, поиск в боковой панели — это чистая альтернатива.
Как работает поиск#
Docsbook индексирует все markdown-содержимое в вашем репозитории. Индекс поиска обновляется автоматически при изменении вашей документации на GitHub.
Поиск охватывает:
- Названия страниц
- Заголовки
- Основной текст
Блоки кода индексируются, но имеют более низкий приоритет, чем прозаический контент.
Помогите читателям мгновенно находить ответы. Подключите свой репозиторий GitHub →