Варианты поиска в статической документации Diplodoc
В статической сборке документации на базе Diplodoc вы можете подключить встроенный поиск одним из трех способов:
-
Локальный поиск (Lunr.js)
Поиск выполняется в браузере пользователя — индекс загружается вместе с документацией. Такой вариант не требует внешнего сервера, работает в офлайн-окружениях и подходит для небольших/средних по объему проектов. Настраивается через секцию конфигурации с провайдеромlocal.
Подробнее: Локальный поиск Lunr.js -
Облачный поиск (Algolia)
Для больших или публичных документаций доступен облачный поиск через сервис Algolia. Индексация и поиск выполняются во внешнем сервисе. Подключается с помощью секцииsearchс провайдеромalgoliaи соответствующими параметрами.
Подробнее: Облачный поиск Algolia -
Внешний HTTP-поиск: подключите свой сервис, в том числе шлюз к OpenSearch, через общий GET/JSON-контракт. Браузер отправляет запросы на указанный endpoint. Настройка и HTTP-контракт.
По умолчанию поиск не активирован. Чтобы воспользоваться одной из реализаций, добавьте и настройте секцию search в файле настроек проекта .yfm.
Экспорт JSON для поиска
Чтобы подготовить содержимое страниц в общем формате для внешней поисковой системы, включите экспорт JSON при сборке. Экспорт работает независимо от поиска на сайте.