infisearch

InfiRecherche

❗ Obsolète ❗

Ce projet n'est plus activement développé.

Comme alternative à la recherche de site statique évolutive, veuillez consulter https://pagefind.app/ qui implémente également l'idée de base d'InfiSearch - un index statique fragmenté.

La documentation de la dernière version continuera d'être hébergée aux URL de ce README, si nécessaire.

Si vous avez essayé ou même contribué à InfiSearch avec des idées et des rapports, merci pour l'énorme investissement de temps.

Recherche facile et flexible côté client pour les sites statiques.

Description

InfiSearch est une solution de recherche côté client conçue pour les sites statiques, dépendant d'un index prédéfini généré par un outil CLI.

Caractéristiques

• Recherche pertinente ? : correction orthographique, recherche automatique de préfixes, requêtes booléennes et de phrases, score BM25, score de proximité, filtres à facettes et plus encore...
• Speedy ? : optimisé par WebAssembly et WebWorker, permettant un traitement des requêtes efficace et non bloquant. Soutenu par une mise en cache persistante pour minimiser les requêtes réseau et un indexeur CLI multithread.
• Semi-évolutif , obtenu en divisant éventuellement l'index en petits morceaux, avec une indexation incrémentielle.
• Une interface utilisateur personnalisable et accessible
• Prise en charge de plusieurs formats de fichiers ( .json,csv,pdf,html ) pour satisfaire des exigences de données plus personnalisées.

Documentation

La documentation, qui utilise InfiSearch pour sa fonction de recherche, peut être trouvée ici.

Aperçu

Certaines démos d'InfiSearch sur une collection Gutenberg beaucoup plus grande sont également disponibles ici.

Commencer

La mise en œuvre d'une recherche de site statique avec InfiSearch est extrêmement simple et ne nécessite qu'un dossier de vos fichiers HTML : les titres, en-têtes et autres textes sont automatiquement extraits. Les liens vers vos pages sont automatiquement générés en fonction de la structure de vos dossiers, mais peuvent également être spécifiés manuellement.

1. Installation de l'indexeur

Il existe plusieurs options pour installer l'indexeur :

• Installez le package npm global avec npm install -g @infisearch/cli .
• Si vous disposez de la configuration des chaînes d'outils rust / cargo, exécutez cargo install infisearch --vers 0.10.1 .
• Vous pouvez également récupérer les binaires cli ici.

2. Exécution de l'indexeur

Exécutez l'exécutable en tant que tel, en remplaçant <source-folder-path> par le chemin de dossier relatif ou absolu de vos fichiers HTML source, et <output-folder-path> par le dossier de sortie d'index souhaité.

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

3. Installation de l'interface utilisateur de recherche via CDN

Ajoutez les ressources suivantes à vos pages :

 <!--  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 vous souhaitez héberger les fichiers, vous pouvez les retrouver dans le répertoire <output-folder-path>/assets généré par l'indexeur, ou dans la page des versions.

4. Initialisation de l'interface utilisateur

Donnez à n'importe quel élément <input> de votre page un id infi-search , puis appelez :

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

Licence

Ce projet est sous licence MIT.