Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ang-zeyu/infisearch
Easy and flexible client-side search for static sites
https://github.com/ang-zeyu/infisearch
jamstack javascript rust search static-site wasm
Last synced: 24 days ago
JSON representation
Easy and flexible client-side search for static sites
- Host: GitHub
- URL: https://github.com/ang-zeyu/infisearch
- Owner: ang-zeyu
- License: mit
- Created: 2021-08-10T02:56:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T17:04:33.000Z (over 1 year ago)
- Last Synced: 2024-09-29T14:02:12.064Z (about 1 month ago)
- Topics: jamstack, javascript, rust, search, static-site, wasm
- Language: Rust
- Homepage: https://infi-search.com
- Size: 60 MB
- Stars: 41
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# InfiSearch
Easy and flexible client-side search for static sites.
## Description
InfiSearch is a client-side search solution made for static sites, depending on a pre-built index generated by a CLI tool.
## Features
- **Relevant Search** 🔍: spelling correction, automatic prefix search, boolean and phrase queries, BM25 scoring, proximity scoring, facet filters and more...
- **Speedy** 🏇: WebAssembly & WebWorker powered, enabling efficient, non-blocking query processing. Backed by persistent caching to minimize network requests, and a multi-threaded CLI indexer.
- **Semi-Scalable**, achieved by optionally splitting the index into tiny morsels, complete with incremental indexing.
- A **customisable**, **accessible** [user interface](https://infi-search.com/infisearch/search_configuration_styling.html) 🖥️
- Support for **multiple file formats** (`.json,csv,pdf,html`) to satisfy more custom data requirements.
## Documentation
The documentation, which uses InfiSearch for its search function, can be found [here](https://infi-search.com/infisearch/getting_started.html).
## Preview
Some demos of InfiSearch on a much larger Gutenberg collection are also available [here](https://infi-search.com).
## Getting Started
Powering static site search with InfiSearch is extremely easy, and requires just a folder of your HTML files — titles, headings, and other text are automatically extracted. Links to your pages are automatically generated based on your folder structure, but can also be manually specified.
### 1. Installing the indexer
There are a couple of options for installing the indexer:
- Install the global npm package with `npm install -g @infisearch/cli`.
- If you have the rust / cargo toolchains setup, run `cargo install infisearch --vers 0.10.1`.
- You can also grab the cli binaries [here](https://github.com/ang-zeyu/infisearch/releases).
### 2. Running the indexer
Run the executable as such, replacing `` with the relative or absolute folder path of your source html files, and `` with your desired index output folder.
```
infisearch
```
### 3. Installing the Search UI via CDN
Add the following resources to your pages:
```html
```
If you wish to host the files, you can find them in the `/assets` directory generated by the indexer, or in the [releases](https://github.com/ang-zeyu/infisearch/releases) page.
### 4. UI Initialisation
Give any `` element in your page an `id` of `infi-search`, then call:
```js
infisearch.init({
searcherOptions: {
// Output folder URL specified as the second parameter in the cli command
// URLs like '/output/' will work as well
url: 'http:///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:///source/',
}
});
```
## License
This project is [MIT licensed](./LICENSE.md).