Skip to content
d2df78d
Compare
Choose a tag to compare

New Features

  • Adds the Javascript registration option 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!)
  • Setting output.excerpts_per_result to 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.

Bug Fixes

  • Fixes a bug where multiple instances of the element described in the exclude_html_selector configuration 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!)

Other

  • Internal dependency updates
58bd7ed
Compare
Choose a tag to compare

Bug Fixes

  • Fixes a regression where the test server (stork test) was inaccessible
  • Fixes a regression where error messages weren't displayed if no files could successfully be indexed
  • Themes now compensate for border radius when displaying progress bar (Thanks @jmooring!)
87a5cd2
Compare
Choose a tag to compare

Bug Fixes

  • Fixes a regression that prevented the Stork CLI from reading index configuration from stdin
  • Fixes an architectural decision that prevented Stork from being published to crates.io
Compare
Choose a tag to compare

Important Changes

  • Starting with 1.4.0, the JS, CSS, and WASM files at the root of the files.stork-search.net CDN will no longer be updated. From this release going forward, you will need to change your <script> tags and <link rel="stylesheet"> tags to upgrade to a new version of Stork. See this Github announcement for more details.

New Features

  • 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 --json flag for the search subcommand is now deprecated, as it did nothing in previous versions of Stork.
  • CLI: A new command line option for the search subcommand, --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, pretty will be the default value for this flag.
  • Two new CSS themes, edible and edible-dark, have been added. See https://stork-search.net/themes for examples and instructions on how to integrate them into your project.

Bug Fixes

  • Removes a stray console.log from the Javascript application
  • Fixes a Javascript runtime bug where registered indexes weren't always reporting as ready
  • Fixes a crash when the indexed contents contained words longer than 128 characters
  • The --timings flag previously did nothing. Now, when included with the build or search subcommands, 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.
Compare
Choose a tag to compare

New Features

  • Indexes alt and title attributes 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: flat

Bug Fixes

  • 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!)

Other

  • Updates dependencies
Compare
Choose a tag to compare

Bug fixes:

  • Fixes issue where [x] button in Basic or Dark themes wouldn't respond to the resizing of the stork-wrapper container (#176)
  • 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!)
Compare
Choose a tag to compare

New Features

  • 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 filename key in the output configuration.

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_error configuration option to stop indexing when first file fails, rather than continuing without the erroring file. #160

Bug Fixes

Compare
Choose a tag to compare

New Features

  • Added self-hosting support. Read the self-hosting documentation to learn more.
  • Added Javascript lifecycle methods to give you control over when the WASM downloads, when the index file is downloaded, and when Stork attaches to the DOM. This will greatly improve the Stork experience when using React-based static site generators, such as Next.js or Gatsby. Read the Advanced JS documentation to learn more.
  • New Javascript API method for searching an index without requiring that you use Stork's UI. If you want to build your own Stork UI from scratch, this is the method for you. The Advanced JS documentation link will help you get started with this, too.
  • New Javascript configurations:
    • 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 --build command, instead of requiring that you pass in a file path.
5bb61d0
Compare
Choose a tag to compare

Bug Fixes:

  • The html_selector option in the configuration file wasn't being parsed correctly, leading to the feature seemingly not working

Enhancements:

  • Better error message when there are no valid files
Compare
Choose a tag to compare

Bug Fixes:

  • Javascript library was erroring incorrectly if the output HTML element could not be found
  • Javascript library was adding stray elements to the DOM while the index was loading

Enhancements:

  • Hyphens are now treated the same as spaces for indexing and searching purposes. In effect, you can now search for avon and it will match the term Stratford-upon-Avon in 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.

Note: Javascript bug fixes get applied automatically if you're loading the Stork library from files.stork-search.net.