Системы поиска

Главная задача любой системы поиска - это дать пользователю найти нужную информацию.

На платформе Docusaurus рассматриваются 3 способа организации систем поиска:

• Использования плагинов локального поиска (см. здесь)
• На основе внешних ресурсов (Algolia DocSearch, Typesense DocSearch)
• На основе собственных компонентов (https://docusaurus.io/docs/search#using-your-own-search)

Рассмотрим плюсы и минусы разных подходов:

• Использования плагинов локального поиска
  • Плюсы:
    • плагин изначально бесплатен, находится в публичном доступе на GitHub
  • Минусы:
    • по мере развития платформы Docusaurus нет гарантии, что плагин будет обновляться на GitHub
    • организация поиска не всегда может соответствовать требованиям по полноте представляемой информации
    • документация на уровне файла readme
• На основе внешних ресурсов
  • Плюсы:
    • постоянное развитие поисковой системы, включение новых "фишек" в процесс поиска
    • поддержка работы с ресурсом: документация, сообщество, администрирование
  • Минусы:
    • изначально бесплатный проект в какой-то момент может стать платным или ограниченным в бесплатной версии
    • отключение из-за каких внешних проявлений, например санкций
    • блокировка из-за бездействия ресурса, например:
      Рис. 1 - Письмо о блокировке поддержки сайта
• На основе собственных компонент
  • Плюсы:
    • можно поддерживать развитие платформы, "крутить" интерфейсом и возможностями
  • Минусы:
    • может потребовать "сильного погружения" в механику работы и не факт, что собственная реализация будет лучше, чем использование плагинов или внешних ресурсов

Исходя из удобства использования и степени, затрачиваемых усилий на создание поисковой системы, рассмотрим:

• Использование плагина @easyops-cn/docusaurus-search-local
• Использование внешнего ресурса на примере Algolia

См. также
Документация