What is Stork?
Stork is a library focused on bringing powerful, visually appealing, and high-speed full-text search capabilities to static websites and personal blogs. It operates as a two-part system: a command-line tool that indexes your local document collection and generates a compact search index file, and a lightweight JavaScript/WebAssembly library that instantly queries this index in the browser, providing users with highly responsive search experiences.
Developers can easily integrate Stork into their projects by following simple setup steps and customize its appearance with CSS or pre-made themes. The tool is ideal for Jamstack architectures, personal blogs, documentation websites, and other static content environments where serverless, client-side search is needed. Stork's flexibility in configuring indices and metadata ensures precision and adaptability to diverse content structures.
Features
- Super Fast Search Interface: Uses WebAssembly and JavaScript for immediate, as-you-type search results.
- Two-Part System: Includes a Rust-based command-line tool for indexing and a front-end JavaScript library for searching.
- Customizable Appearance: Easily adapts to custom stylesheets or uses provided themes for polished interfaces.
- Flexible Indexing: Allows configuration of input documents and metadata for tailored search results.
- Simple Integration: Quick setup by adding HTML and registering indices for search functionality.
- Suitable for Static Content: Perfect for blogs, documentation, and Jamstack websites without server-side requirements.
- Open Source: Transparent, modifiable code and community contributions via GitHub.
Use Cases
- Adding full-text search to personal or professional static blogs.
- Enabling instant search on documentation sites without a backend.
- Providing search interfaces for static online portfolios or project collections.
- Enhancing Jamstack sites with responsive, client-side search functionality.
- Building searchable archives of academic papers or articles.
