infisearch

InfiBuscar

❗ Obsoleto ❗

Este proyecto ya no se desarrolla activamente.

Como alternativa para la búsqueda de sitios estáticos escalables, consulte https://pagefind.app/, que también implementa la idea central de InfiSearch: un índice estático fragmentado.

La documentación de la última versión seguirá alojada en las URL de este README, si es necesario.

Si ha estado probando o incluso contribuyendo con ideas e informes a InfiSearch, gracias por la enorme inversión de tiempo.

Búsqueda fácil y flexible del lado del cliente para sitios estáticos.

Descripción

InfiSearch es una solución de búsqueda del lado del cliente diseñada para sitios estáticos, que depende de un índice prediseñado generado por una herramienta CLI.

Características

• ¿ Búsqueda relevante ?: corrección ortográfica, búsqueda automática de prefijos, consultas booleanas y de frases, puntuación BM25, puntuación de proximidad, filtros de facetas y más...
• ¿ Rápido ?: WebAssembly y WebWorker, que permiten un procesamiento de consultas eficiente y sin bloqueo. Respaldado por almacenamiento en caché persistente para minimizar las solicitudes de red y un indexador CLI de subprocesos múltiples.
• Semiescalable , que se logra dividiendo opcionalmente el índice en pequeños fragmentos, completo con indexación incremental.
• Una interfaz de usuario accesible y personalizable
• Soporte para múltiples formatos de archivos ( .json,csv,pdf,html ) para satisfacer requisitos de datos más personalizados.

Documentación

La documentación, que utiliza InfiSearch para su función de búsqueda, se puede encontrar aquí.

Avance

Algunas demostraciones de InfiSearch en una colección de Gutenberg mucho más grande también están disponibles aquí.

Empezando

Impulsar la búsqueda de sitios estáticos con InfiSearch es extremadamente fácil y solo requiere una carpeta de sus archivos HTML: los títulos, encabezados y otro texto se extraen automáticamente. Los enlaces a sus páginas se generan automáticamente según la estructura de su carpeta, pero también se pueden especificar manualmente.

1. Instalación del indexador

Hay un par de opciones para instalar el indexador:

• Instale el paquete npm global con npm install -g @infisearch/cli .
• Si tiene configuradas las cadenas de herramientas de óxido/carga, ejecute cargo install infisearch --vers 0.10.1 .
• También puedes obtener los binarios de cli aquí.

2. Ejecutando el indexador

Ejecute el ejecutable como tal, reemplazando <source-folder-path> con la ruta relativa o absoluta de la carpeta de sus archivos html de origen, y <output-folder-path> con la carpeta de salida del índice que desee.

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

3. Instalación de la interfaz de usuario de búsqueda a través de CDN

Agregue los siguientes recursos a sus páginas:

 <!--  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 " />

Si desea alojar los archivos, puede encontrarlos en el directorio <output-folder-path>/assets generado por el indexador o en la página de lanzamientos.

4. Inicialización de la interfaz de usuario

Asigne a cualquier elemento <input> de su página una id de infi-search y luego llame a:

 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/' ,
  }
} ) ; 

Licencia

Este proyecto tiene licencia del MIT.