Skip to content

v2.0.0-beta.1

Pre-release
Pre-release
Compare
Choose a tag to compare
@github-actions github-actions released this 06 Feb 04:14
· 1 commit to master since this release

This is the first beta release of the Stork 2.0.0 release branch. The beta signifier means that the release is documented and usable, though the API is not final and not all features have been implemented yet.

Until 2.0.0 is released, the source code is stored in the v2 branch of the repository.

The documentation is available here.

Note
In this beta, you'll have to explicitly register the WASM blob with a custom URL:

stork.initialize("https://files.stork-search.net/releases/latest/stork.wasm")

2.0.0 greatly simplifies the search algorithm. As a result, the indexing binary, WASM blob, and Javascript file are all smaller than the 1.x branch. Searches are faster. The configuration API is more powerful.

The following features are still not working:

  • Sharded indexes. The file format supports them, the library supports merging shards together, but the builder doesn't yet know how to split an index into multiple parts.
  • Stemming
  • HTML parsing, including the included and excluded selectors
  • Matching search results in titles
  • Result and excerpt scoring, leading to strange ordering of results

Currently, only search indexes made with the 2.0.0 indexer binary can be used with the 2.0.0 web code. This lets me greatly simplify the support matrix, so I'm inclined to leave it that way; please let me know if this would be troublesome for your workflow.

Please give me feedback if you have any!


The following artifacts have been uploaded to the Stork CDN:

  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork.js
  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork.wasm
  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork.css
  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork-ubuntu-20-04
  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork-ubuntu-22-04
  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork-macos-11
  • https://files.stork-search.net/releases/v2.0.0-beta.1/stork-macos-12
  • https://files.stork-search.net/releases/v2.0.0-beta.1/federalist.st
  • https://files.stork-search.net/releases/v2.0.0-beta.1/3b1b.st