Варианты поиска в статической документации Diplodoc

В статической сборке документации на базе Diplodoc вы можете подключить встроенный поиск одним из двух способов:

  • Локальный поиск (Lunr.js)
    Поиск выполняется в браузере пользователя — индекс полностью загружается вместе с вашей документацией. Такой вариант не требует внешнего сервера, работает даже в полностью офлайн-окружениях и подходит для небольших/средних по объему проектов. Настраивается через секцию конфигурации с провайдером local.
    Подробнее: Локальный поиск Lunr.js

  • Облачный поиск (Algolia)
    Для больших или публичных документаций рекомендуется облачный поиск через сервис Algolia. Индексация и поиск осуществляются во внешнем сервисе, что обеспечивает высокую скорость, релевантность и масштабируемость. Подключается с помощью секции search с провайдером algolia и соответствующими параметрами.
    Подробнее: Облачный поиск Algolia

По умолчанию поиск не активирован. Чтобы воспользоваться одной из реализаций, добавьте и настройте секцию search в конфиге сборки.