infisearch Download - infisearch Quellcode herunterladen

infisearch

Anderer Quellcode

v0.10.1

Herunterladen

InfiSearch

❗Veraltet❗

Dieses Projekt wird nicht mehr aktiv weiterentwickelt.

Als Alternative zur skalierbaren statischen Site-Suche sehen Sie sich bitte https://pagefind.app/ an, das auch die Kernidee von InfiSearch implementiert – einen fragmentierten statischen Index.

Die Dokumentation für die neueste Release-Version wird bei Bedarf weiterhin unter den URLs in dieser README-Datei gehostet.

Wenn Sie InfiSearch ausprobiert oder sogar Ideen und Berichte dazu beigetragen haben, vielen Dank für die enorme Zeitinvestition.

Einfache und flexible clientseitige Suche nach statischen Websites.

Beschreibung

InfiSearch ist eine clientseitige Suchlösung für statische Websites, die auf einem vorgefertigten Index basiert, der von einem CLI-Tool generiert wird.

Merkmale

Relevante Suche ?: Rechtschreibkorrektur, automatische Präfixsuche, boolesche und Phrasenabfragen, BM25-Bewertung, Näherungsbewertung, Facettenfilter und mehr ...
Schnell ?: Unterstützt WebAssembly und WebWorker und ermöglicht eine effiziente, nicht blockierende Abfrageverarbeitung. Unterstützt durch dauerhaftes Caching zur Minimierung von Netzwerkanforderungen und einen Multithread-CLI-Indexer.
Halbskalierbar , erreicht durch optionale Aufteilung des Index in kleine Häppchen, komplett mit inkrementeller Indizierung.
Eine anpassbare , zugängliche Benutzeroberfläche
Unterstützung für mehrere Dateiformate ( .json,csv,pdf,html ), um individuellere Datenanforderungen zu erfüllen.

Dokumentation

Die Dokumentation, die InfiSearch für ihre Suchfunktion nutzt, finden Sie hier.

Vorschau

Einige Demos von InfiSearch auf einer viel größeren Gutenberg-Sammlung sind auch hier verfügbar.

Erste Schritte

Die statische Site-Suche mit InfiSearch ist äußerst einfach und erfordert lediglich einen Ordner mit Ihren HTML-Dateien – Titel, Überschriften und anderer Text werden automatisch extrahiert. Links zu Ihren Seiten werden automatisch basierend auf Ihrer Ordnerstruktur generiert, können aber auch manuell angegeben werden.

1. Installation des Indexers

Für die Installation des Indexers gibt es mehrere Möglichkeiten:

Installieren Sie das globale npm-Paket mit npm install -g @infisearch/cli .
Wenn Sie die Rust-/Cargo-Toolchains eingerichtet haben, führen Sie cargo install infisearch --vers 0.10.1 aus.
Sie können die CLI-Binärdateien auch hier herunterladen.

2. Ausführen des Indexers

Führen Sie die ausführbare Datei als solche aus und ersetzen Sie dabei <source-folder-path> durch den relativen oder absoluten Ordnerpfad Ihrer Quell-HTML-Dateien und <output-folder-path> durch Ihren gewünschten Indexausgabeordner.

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

3. Installation der Such-Benutzeroberfläche über CDN

Fügen Sie Ihren Seiten die folgenden Ressourcen hinzu:

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

Wenn Sie die Dateien hosten möchten, finden Sie sie im vom Indexer generierten Verzeichnis <output-folder-path>/assets oder auf der Release-Seite.

4. UI-Initialisierung

Geben Sie jedem <input> -Element auf Ihrer Seite die id infi-search und rufen Sie dann Folgendes auf:

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