Полнотекстовый поиск и горячие клавиши
При работе с большим объёмом технической документации критически важно быстро находить нужный параметр конфигурации. В EpoCanvas Docs встроен двухрежимный поиск: поле поиска в верхней панели быстро находит совпадения на текущей странице, а окно Ctrl+K выполняет поиск по всем документам сайта. Оба режима работают полностью локально в браузере и не требуют серверной части, поэтому сайт доступен для поиска даже в интранете без доступа к интернету.
Какой режим поиска когда использовать?
| Ситуация | Какой режим | Как действовать |
|---|---|---|
| Помните, что нужный фрагмент находится в текущей статье | Поиск по странице | Кликните поле поиска в верхней панели и введите ключевое слово |
| Не уверены, в какой статье находится материал, нужен поиск по всему сайту | Поиск по сайту | Нажмите Ctrl + K (на Mac — Cmd + K) |
Поиск по странице: поле поиска в верхней панели
Кликните поле поиска в центре верхней панели страницы (значок лупы) и сразу введите ключевое слово:
Рисунок: реальный результат с аннотациями после ввода «部署» в поле поиска верхней панели. ① поле ввода в верхней панели; ② счётчик совпадений (сейчас N-е совпадение из M); ③ кнопки перехода к предыдущему / следующему совпадению; ④ кнопка очистки; ⑤ все совпавшие фрагменты на текущей странице подсвечиваются автоматически.
Ввод ключевых слов
Поддерживаются фразы на русском (например, «развёртывание», «компонент»), английские слова и фрагменты кода (например, pnpm, astro.config.mjs). Во время ввода весь совпавший текст на текущей странице сразу подсвечивается цветом, а страница автоматически прокручивается к первому совпадению.
Переход между совпадениями
- Нажмите Enter или кликните стрелку вниз: переход к следующему совпадению;
- Нажмите Shift + Enter или кликните стрелку вверх: возврат к предыдущему совпадению;
- В поле поиска в реальном времени отображается счётчик прогресса
N/M(например,3/9), позволяя в любой момент контролировать ход просмотра.
Очистка поиска и восстановление страницы
Нажмите Esc или кликните кнопку ×, чтобы снять всю подсветку и вернуть страницу в исходное состояние.
Поиск по всему сайту: окно Ctrl+K
С какой бы страницы вы ни работали, нажмите Ctrl + K (на Mac — Cmd + K) или кликните бейдж Ctrl K справа от поля поиска — в центре экрана откроется окно глобального поиска:
Рисунок: реальный результат с аннотациями после ввода «部署» в окне поиска. ① бейдж Ctrl K справа от поля поиска (по клику окно также открывается); ② поле ввода запроса; ③ список результатов, сгруппированный по документам, найденные ключевые слова подсвечены; ④ панель подсказок по горячим клавишам внизу.
Ввод ключевых слов
Поддерживаются фразы на русском (например, «развёртывание», «компонент»), английские слова и фрагменты кода (например, pnpm, astro.config.mjs). Результаты с совпадением в заголовке выводятся первыми.
Просмотр списка результатов
Результаты сгруппированы по документам; каждая запись показывает заголовок документа, раздел, в котором найдено совпадение, и предпросмотр контекста с ключевым словом; найденные слова подсвечены. Клик по заголовку группы разворачивает или сворачивает найденные фрагменты этого документа.
Весь процесс с клавиатуры
- ↑ ↓: перемещение выбора между результатами;
- Enter: открыть выбранный результат и перейти к соответствующему разделу;
- Esc: закрыть окно.
Мышь на протяжении всего процесса не нужна.
Почему поиск такой быстрый?
Рисунок: сравнение механизмов работы двухрежимного поиска. Слева — быстрый поиск ключевых слов по текущей странице в верхней панели; справа — поиск по статическому индексу всего сайта на основе Pagefind WASM. Оба режима работают полностью локально в браузере.
У многих сайтов поиск по документации отправляет запрос в базу данных на удалённом сервере, и при плохой сети приходится бесконечно смотреть на индикатор загрузки.
EpoCanvas Docs использует локальное статическое решение для поиска — Pagefind:
- Извлечение индекса при сборке: во время выполнения
pnpm run buildсистема автоматически собирает содержимое каждого документа и генерирует набор сжатых статических файлов-шардов индекса. - Лёгкая загрузка по требованию: при вводе текста в поле поиска браузер загружает только шарды индекса для соответствующих символов (объёмом от нескольких до нескольких десятков КБ).
- Мгновенное локальное сопоставление: сопоставление и сортировка выполняются полностью локально в браузере, поэтому нет задержек на сетевые запросы, и поиск полностью работает в интранете без доступа к интернету.
Советы по использованию поиска
- Разбивка на слова: для более точного поиска введите несколько слов через пробел (например,
Cloudflare домен). - Приоритет заголовков: заголовки документов и разделов имеют наибольший вес в ранжировании; результаты с совпадением по заголовку выводятся первыми.
- Ограничение режима разработки: индекс всего сайта создаётся только при сборке; в сервере разработки, запущенном через
pnpm run dev, диалогCtrl+Kне загружает индекс, поэтому глобальный поиск там недоступен. Чтобы проверить поиск, выполнитеpnpm run build, а затемpnpm run preview. Поиск по странице этого ограничения не касается.