Enabling Search · Docusaurus

Docusaurus поддерживает поиск с помощью Algolia DocSearch. Как только ваш веб-сайт станет доступен онлайн, вы можете предоставить его в DocSearch. Затем Algolia отправит учетные данные, которые можно добавить в ваш siteConfig.js.

DocSearch обходит страницы вашего веб-сайта каждые 24 часа и добавляет их содержимое в индекс Algolia. Затем это содержимое будет запрошено непосредственно из вашего клиентского интерфейса с помощью Algolia API. Note that your website needs to be publicly available for this to work (ie. не закрыт брандмауэром). Этот сервис бесплатный.

Подключение панели поиска

Добавьте свой ключ API и имя индекса (предоставленные сервисом Algolia), в файл siteConfig.js в секцию algolia, чтобы подключить поиск на своем сайте.

const siteConfig = {
  ...
  algolia: {
    apiKey: 'my-api-key',
    indexName: 'my-index-name',
    algoliaOptions: {} // Optional, if provided by Algolia
  },
  ...
};

Дополнительные параметры поиска

Вы также можете указать дополнительные параметры поиска, используемые в Algolia, заполнив поле algoliaOptions в algolia. Это может быть полезно, если вы желаете предоставить разные результаты поиска для различных версий или языков документации. Любое вхождение "VERSION" или "LANGUAGE" будет заменено на версию или язык текущей страницы соответственно. Больше информации о параметрах поиска вы можете найти здесь.

const siteConfig = {
  ...
  algolia: {
    ...
    algoliaOptions: {
      facetFilters: [ "language:LANGUAGE", "version:VERSION" ]
    }
  },
};

Algolia может предоставлять вам дополнительные настройки поиска. В этом случае вам следует добавить их в объект algoliaOptions.

Настройка местоположения панели поиска

По-умолчанию панель поиска размещается как крайний правый элемент в верхней панели навигации.

Если вы желаете изменить местоположение по-умолчанию, добавьте флаг searchBar в поле headerLinks из siteConfig.js в том месте, где вам нужно. Например, вы можете пожелать разместить панель поиска между своими внутренними и внешними ссылками.

const siteConfig = {
  ...
  headerLinks: [
    {...}
    {...}
    { search: true }
    {...}
    {...}
  ],
  ...
};

Настройка атрибута placeholder

Если вы желаете изменить атрибут placeholder (по-умолчанию равен Search), добавьте поле placeholder в свой файл настроек. Например, если вам нужно, чтобы панель поиска отображала фразу Спросите меня о чем-либо:

const siteConfig = {
  ...
  algolia: {
    ...
    placeholder: 'Ask me something'
  },
};

Отключение панели поиска

Чтобы отключить панель поиска, закомментируйте (рекомендуется) или удалите раздел algolia в файле siteConfig.js.

Кроме того, если вы настроили местоположение панели поиска в headerLinks, установите search: false.