Roadmap

Stork is still a beta project. There are aspects of the project where it's fallen short of the design decisions, where it seems broken, and where it seems like it should be able to do more. While it's in beta (and likely beyond), I'm going to list out the project roadmap and expected features on this page to keep me accountable for how Stork evolves.

Overarching goals:

  • Reduce index size and keep WebAssembly bundle size low
  • Keep search fast (responsive on a per-keystroke basis)
  • Keep the API easy to get started and easy to configure
  • Build out configuration options so that search behavior can fit different types of content
  • Maintain compatibility with old config files and indexes

1.0.0

  • Keyboard shortcuts on JS
  • Support the SRT file format
  • Callbacks in JS for different user events
  • Sorting the results by relevance Added in 0.5.3
  • Sensible handling of multi-word queries Added in 0.5.3
  • Different options for indexing behavior
  • Different options for allowed input, like files with frontmatter, or lists of files

1.1.0

  • Write and publish some themes: first-party stylesheets that change the UI of the search interface
  • Write and publish some integrations with other projects, e.g. various static site generators, Wordpress, etc.
  • Convert JS code to Typescript

More specific bugs and features are listed on the project's Github Issues page. Feel free to submit a feature request there.

© 2019–2020

Stork is built and shepherded by James Little, who's really excited that you're checking it out. If you have any questions or comments, feel free to get in touch or open an issue on Github.

This site is also on Github; feel free to put up a PR or open an issue if you see something worth changing.