infisearch

ИнфиПоиск

❗ Устарело ❗

Этот проект больше не активно развивается.

В качестве альтернативы масштабируемому статическому поиску по сайту можно использовать https://pagefind.app/, который также реализует основную идею InfiSearch — фрагментированный статический индекс.

При необходимости документация для последней версии будет по-прежнему размещаться по URL-адресам в этом README.

Если вы пробовали или даже предлагали идеи и отчеты для InfiSearch, спасибо за потраченное время.

Простой и гибкий поиск статических сайтов на стороне клиента.

Описание

InfiSearch — это решение для поиска на стороне клиента, созданное для статических сайтов и использующее предварительно созданный индекс, созданный с помощью инструмента CLI.

Функции

• Релевантный поиск ?: исправление орфографии, автоматический поиск по префиксам, логические и фразовые запросы, оценка BM25, оценка близости, фильтры фасетов и многое другое...
• Speedy ?: поддержка WebAssembly и WebWorker, обеспечивающая эффективную неблокирующую обработку запросов. Поддерживается постоянным кэшированием для минимизации сетевых запросов и многопоточным индексатором CLI.
• Полумасштабируемость , достигаемая путем опционального разделения индекса на мелкие кусочки в сочетании с инкрементной индексацией.
• Настраиваемый , доступный пользовательский интерфейс
• Поддержка нескольких форматов файлов ( .json,csv,pdf,html ) для удовлетворения большего количества требований к пользовательским данным.

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

Документацию, использующую InfiSearch для функции поиска, можно найти здесь.

Предварительный просмотр

Некоторые демо-версии InfiSearch в гораздо большей коллекции Гутенберга также доступны здесь.

Начиная

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

1. Установка индексатора

Есть несколько вариантов установки индексатора:

• Установите глобальный пакет npm с помощью npm install -g @infisearch/cli .
• Если у вас есть набор инструментов Rust/Cargo, запустите cargo install infisearch --vers 0.10.1 .
• Вы также можете скачать двоичные файлы cli здесь.

2. Запуск индексатора

Запустите исполняемый файл как таковой, заменив <source-folder-path> относительным или абсолютным путем к папке исходных html-файлов, а <output-folder-path> желаемой папкой вывода индекса.

 infisearch <source-folder-path> <output-folder-path>

3. Установка пользовательского интерфейса поиска через CDN

Добавьте на свои страницы следующие ресурсы:

 <!--  Search UI script -->
< script src =" https://cdn.jsdelivr.net/gh/ang-zeyu/[email protected]/packages/search-ui/dist/search-ui.ascii.bundle.js " > </ script >
<!-- Search UI css, this provides some basic styling for the search dropdown, and can be omitted if desired -->
< link rel =" stylesheet " href =" https://cdn.jsdelivr.net/gh/ang-zeyu/[email protected]/packages/search-ui/dist/search-ui-light.css " />

Если вы хотите разместить файлы, вы можете найти их в каталоге <output-folder-path>/assets , созданном индексатором, или на странице выпусков.

4. Инициализация пользовательского интерфейса

Присвойте любому элементу <input> на вашей странице id infi-search , а затем вызовите:

 infisearch . init ( {
  searcherOptions : {
    // Output folder URL specified as the second parameter in the cli command
    // URLs like '/output/' will work as well
    url : 'http://<your-domain>/output/' ,
  } ,
  uiOptions : {
    // Input folder URL specified as the first parameter in the cli command
    // This is where the generated result preview links will point to,
    // and where you host your site.
    sourceFilesUrl : 'http://<your-domain>/source/' ,
  }
} ) ; 

Лицензия

Этот проект имеет лицензию MIT.