infisearch

InfiSearch

❗ Obsoleto ❗

Este projeto não está mais sendo desenvolvido ativamente.

Como alternativa para pesquisa escalável em sites estáticos, verifique https://pagefind.app/ que também implementa a ideia central do InfiSearch - um índice estático fragmentado.

A documentação da versão mais recente continuará hospedada nas URLs deste README, se necessário.

Se você tem experimentado ou até mesmo contribuído com ideias e relatórios para o InfiSearch, obrigado pelo enorme investimento de tempo.

Pesquisa fácil e flexível do lado do cliente para sites estáticos.

Descrição

InfiSearch é uma solução de pesquisa do lado do cliente feita para sites estáticos, dependendo de um índice pré-construído gerado por uma ferramenta CLI.

Características

• Pesquisa relevante ?: correção ortográfica, pesquisa automática de prefixo, consultas booleanas e de frase, pontuação BM25, pontuação de proximidade, filtros de faceta e muito mais...
• Speedy ?: baseado em WebAssembly e WebWorker, permitindo processamento de consultas eficiente e sem bloqueios. Apoiado por cache persistente para minimizar solicitações de rede e um indexador CLI multithread.
• Semiescalável , obtido opcionalmente pela divisão do índice em pequenos pedaços, completo com indexação incremental.
• Uma interface de usuário personalizável e acessível
• Suporte para vários formatos de arquivo ( .json,csv,pdf,html ) para satisfazer mais requisitos de dados personalizados.

Documentação

A documentação, que utiliza o InfiSearch para sua função de pesquisa, pode ser encontrada aqui.

Visualização

Algumas demonstrações do InfiSearch em uma coleção muito maior de Gutenberg também estão disponíveis aqui.

Começando

Alimentar a pesquisa estática de sites com o InfiSearch é extremamente fácil e requer apenas uma pasta com seus arquivos HTML – títulos, cabeçalhos e outros textos são extraídos automaticamente. Os links para suas páginas são gerados automaticamente com base na estrutura de pastas, mas também podem ser especificados manualmente.

1. Instalando o indexador

Existem algumas opções para instalar o indexador:

• Instale o pacote npm global com npm install -g @infisearch/cli .
• Se você tiver os conjuntos de ferramentas ferrugem/carga configurados, execute cargo install infisearch --vers 0.10.1 .
• Você também pode obter os binários cli aqui.

2. Executando o indexador

Execute o executável como tal, substituindo <source-folder-path> pelo caminho da pasta relativo ou absoluto dos arquivos HTML de origem e <output-folder-path> pela pasta de saída do índice desejada.

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

3. Instalando a interface de pesquisa via CDN

Adicione os seguintes recursos às suas 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 " />

Se desejar hospedar os arquivos, você pode encontrá-los no diretório <output-folder-path>/assets gerado pelo indexador ou na página de lançamentos.

4. Inicialização da IU

Dê a qualquer elemento <input> da sua página um id de infi-search e chame:

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

Licença

Este projeto é licenciado pelo MIT.