transformResultUrl, which, when set, transforms search result URLs from what's described in the search index to what gets output in the DOM. (Thanks, @ArsenArsen!)
output.excerpts_per_resultto 0 in your configuration file will now enable index serialization optimizations that can reduce your index filesize by 20-50%. Note that this will make all excerpts disappear from the search UI.
- Fixes a bug where multiple instances of the element described in the
exclude_html_selectorconfiguration option were not being correctly excluded. (Thanks, @ezekg!)
- Fixes a crash when trying to parse noncompliant Markdown contents (Thanks, @userJY!)
- Fixes a bug when highlighting search results where highlights wouldn't surround an entire word. (Thanks, @kdheepak!)
- Internal dependency updates
- Starting with 1.4.0, the JS, CSS, and WASM files at the root of the
files.stork-search.netCDN will no longer be updated. From this release going forward, you will need to change your
<link rel="stylesheet">tags to upgrade to a new version of Stork. See this Github announcement for more details.
- Configuration files can now be in JSON format, in addition to TOML format
- The web library now takes the number of occurrences in each file into account when ordering search results.
- CLI: The
--jsonflag for the
searchsubcommand is now deprecated, as it did nothing in previous versions of Stork.
- CLI: A new command line option for the
--format <VALUE>, now determines how search results will be displayed in the terminal. The default value is
json, which will display the search results in the JSON format understood by the browser module. A new value,
pretty, will format the search results in a readable, understandable way. In the 2.0.0 Stork release,
prettywill be the default value for this flag.
- Two new CSS themes,
edible-dark, have been added. See https://stork-search.net/themes for examples and instructions on how to integrate them into your project.
- Removes a stray
- Fixes a crash when the indexed contents contained words longer than 128 characters
--timingsflag previously did nothing. Now, when included with the
searchsubcommands, timing information will be displayed at the end of the terminal output via stderr.
- Document titles that were comprised of several words separated by hyphens would crash the search interface. This has been fixed.
titleattributes on HTML elements
- Adds configuration keys to set an HTML selector as excluded from indexing
- Adds a configuration key,
output.save_nearest_html_id, that, when set to true, will index the nearest HTML IDs for each word. The web interface will link to that ID; clicking on that search result will jump to the text's location on the page.
- Reduces JS and WASM artifact sizes by changing build system settings
- Updates CSS themes, and adds a new theme:
- Fixes a bug where users were able to accidentally download two instances of Stork's WASM on the page (Thanks @justinmayer!)
- Fixes a bug where the indexer was hanging in environments where stdin was not passed in as an empty stream (Thanks @Aethon!)
- Updates dependencies
- Fixes issue where [x] button in Basic or Dark themes wouldn't respond to the resizing of the
- Fixes issue where searching for three characters wouldn't display results on the web page (#172)
- Fixes crash when the title of a document included non-unicode characters (#173 - thanks @Erwan-le-Gall!)
- Stork can now index content from the web. (When the docs are available, a link to the docs will be here!) #146
- Stork's command line interface has been redesigned and rewritten, with backwards-compatible shims added where needed. #160
- This change deprecates the
filenamekey in the output configuration.
- This change deprecates the
Quality of Life Improvements
- If you index a file and get an empty buffer, Stork will let you know there might be a problem. #147
- Adds debug method to JS interface #161
- Improves command line output, especially for errors #160
- Adds a new
break_on_file_errorconfiguration option to stop indexing when first file fails, rather than continuing without the erroring file. #160
- Added self-hosting support. Read the self-hosting documentation to learn more.
onResultsHidden- Callback that gets called when the results are hidden, when the user presses esc or clicks on the close button
onInputCleared- Callback that gets called when the input is cleared, when the user presses esc twice
showCloseButton- Boolean to determine whether the close button is visible or not
- Stork can now take in a configuration file that's piped into the
$ stork --buildcommand, instead of requiring that you pass in a file path.
html_selectoroption in the configuration file wasn't being parsed correctly, leading to the feature seemingly not working
- Better error message when there are no valid files
- Hyphens are now treated the same as spaces for indexing and searching purposes. In effect, you can now search for
avonand it will match the term
Stratford-upon-Avonin your index.
- Stork used to fail the entire indexing process if there was an error parsing a single file. Now, it will collect those errors and present them in the console, but still build an entire index with the remaining files.