Плагин DocSearch

DocSearch - это уникальный бесплатный поиск, специально разработанный для поиска технической документации для проектов с открытым исходным кодом или технических блогов. Предоставляя быстрые и точные параметры поиска, DocSearch позволяет посетителям находить нужную им информацию как можно быстрее. С помощью плагина DocSearch интеграция поиска на ваш сайт Publii занимает всего несколько минут.

Как работает DocSearch?

Как и другие поисковые системы, DocSearch использует скребок для индексации содержимого вашего сайта; проще говоря, скребок считывает содержимое вашего сайта и сохраняет данные, которые затем можно сопоставить для создания пользовательского поиска, эффективного для вашего сайта. Уникально то, что DocSearch ориентирован конкретно на документацию; это означает, что он разработан, чтобы помочь пользователям более эффективно находить ответы на конкретные вопросы или темы в узкой области, а не искать более общую актуальность, а также предлагает функцию автозаполнения, помогающую пользователям находить разделы, которые будут более полезны при ответе на их запрос.

На основе собранных данных Algolia автоматически настроит поиск, соответствующий контенту вашего сайта, а затем предоставит методы для интеграции поиска на ваш сайт. Функциональность поиска обеспечивается самим DocSearch; обработка поискового запроса и выдача результатов происходит отдельно от инфраструктуры вашего сайта.

Зачем нужен DocSearch?

DocSearch разработан исключительно для обеспечения эффективного поиска по релевантной документации; это означает, что он будет более эффективным при ответе на конкретные запросы и указании вам на релевантные разделы документации, а не при более общем поиске, который предоставляет Google или другие поисковые системы.

Если вы используете веб-сайт, предоставляющий техническую документацию по проекту с открытым исходным кодом, то DocSearch - идеальный выбор в качестве поставщика поиска.

Требования к DocSearch

Миссия DocSearch - упростить поиск релевантного контента в технической документации, а не создавать общую поисковую систему, которую может использовать любой сайт. Следовательно, для использования DocSearch каждый сайт должен соответствовать определенным критериям.

Чтобы использовать DocSearch, ваш веб-сайт должен соответствовать этим условиям:

1. Ваш веб-сайт должен быть общедоступным, чтобы DocSearch мог его индексировать.
2. Ваш веб-сайт должен быть сайтом документации для проекта с открытым исходным кодом или техническим блогом. Algolia сократит объем данных, которые они собирают для поиска, до только полезных страниц.
3. Ваш веб-сайт готов к работе; то есть он уже содержит соответствующую содержанию и полезную документацию. Algolia не будет принимать веб-сайты placeholder или lorem ipsum, которые планируется обновить позже.

Как начать?

Как только ваш веб-сайт будет подключен к сети и готов к добавлению функций поиска, вы должны отправить его в DocSearch на их главной странице; форма в шапке сайта позволит вам это сделать. Вам нужно будет только указать URL веб-сайта и свой адрес электронной почты, чтобы вы могли получить учетные данные для поиска, когда они будут готовы; обратите внимание, что вам также нужно будет быть владельцем соответствующего веб-сайта и подтвердить это при подаче заявки. Как только Algolia примет вашу заявку, они отправят вам учетные данные для включения поиска по электронной почте.

После получения электронного письма с подтверждением вам нужно будет скопировать следующие данные, чтобы добавить их в параметры плагина:

• Идентификатор приложения
• Ключ API поиска
• Название индекса

После включения плагина и добавления соответствующих данных DocSearch будет сканировать ваш веб-сайт каждые 24 часа, чтобы убедиться в актуальности вашего поиска.

Команда DocSearch рекомендует, чтобы ваш сайт включал карту сайта, поскольку это позволит ему лучше отслеживать изменения, и это имеет дополнительное преимущество, поскольку считается лучшей практикой для SEO. По умолчанию Publii создает для вас полную карту сайта, но если вы хотите проверить, включена ли она, или исключить содержимое из карты сайта, вы можете сделать это в разделе Настройки → Дополнительные параметры → Карта сайта интерфейса Publii.

Включение раздела поиска

Все официальные темы Publii имеют встроенную в тему область поиска, которую необходимо включить, прежде чем плагин сможет функционировать. Чтобы включить раздел поиска:

1. В главном меню Publii на левой боковой панели нажмите на опцию Настройки темы, чтобы открыть экран настроек.
2. Во втором разделе этого экрана, Пользовательские настройки, нажмите на вкладку Поиск в списке параметров под заголовком пользовательские настройки, чтобы открыть параметры поиска.
3. Нажмите на кнопку переключения рядом с параметром Поиск, чтобы включить панель поиска.
4. Теперь эта область включена в вашей теме, и вы можете перейти к включению и настройке плагина DocSearch.

Включение плагина

Чтобы активировать плагин, откройте раздел Инструменты и плагины приложения Publii через левое меню, чтобы просмотреть список установленных плагинов. Нажмите кнопку переключения в левом нижнем углу окна DocSearch в этом списке, чтобы включить плагин.

Как только плагин и область поиска в теме будут включены, нам нужно будет добавить в настройки плагина идентификатор приложения, ключ API поиска и название индекса , которые были предоставлены DocSearch по электронной почте после утверждения представленного сайта.

Чтобы открыть настройки плагина, нажмите на поле DocSearch еще раз, в любом месте, кроме кнопки переключения, и откроется экран настроек. Обратите внимание, что этот экран будет недоступен, если плагин не будет включен первым.

Параметры DocSearch

Поскольку тяжелая работа по обходу вашего сайта и созданию поиска выполняется самим DocSearch, в плагине есть только три опции, все из которых необходимо настроить, прежде чем плагин сможет работать правильно. Убедитесь, что у вас есть электронное письмо с вашими учетными данными для поиска, которое DocSearch предоставила после принятия заявки на ваш сайт, чтобы соответствующую информацию можно было добавить в параметры плагина. Настройки плагина следующие:

Настройка поиска

• Идентификатор приложения - Введите идентификатор приложения, предоставленный DocSearch, в это поле.
• Ключ API - Введите ключ API, предоставленный DocSearch, в это поле.
• Название индекса - Введите в это поле название индекса, предоставленное DocSearch.

После завершения сохраните изменения, нажав на кнопку Сохранить настройки в нижней части экрана настроек; теперь плагин будет готов к использованию.

Интеграция баннеров с файлами cookie

Плагин DocSearch можно улучшить, включив опцию, которая позволяет пользователям давать согласие на файлы cookie, используемые DocSearch, через встроенный баннер Publii cookie. Если эта опция включена, будет доступна еще одна опция:

• Идентификатор группы файлов cookie - Введите здесь идентификатор группы файлов cookie, в которую должны быть включены файлы DocSearch; например, ’функциональность’. Обязательно добавьте (если оно не существует) это название группы в раздел GDPR настроек сайта. Инструкции о том, как это сделать, вы можете найти в разделе GDPR этой документации.