A Starlight plugin that integrates Typesense with the DocSearch interface to add lightning-fast, typo-tolerant search to your Starlight documentation site.
Typesense is an open-source, lightning-fast search engine that delivers instant, typo-tolerant results with minimal setup. It's an open source alternative to Algolia and an easier-to-use alternative to ElasticSearch.
Starlight is a documentation framework built on Astro, focused on performance, accessibility, and customization. It helps developers create elegant, content-rich documentation sites with ease.
Together, Typesense, Starlight and DocSearch provide a seamless way to add powerful, blazingly-fast search to modern documentation websites.
To power the search experience, you'll need to index your site's content into Typesense.
The typesense-docsearch-scraper is a crawler that scans your documentation pages, extracts structured content (like titles, headings, and paragraphs), and uploads it into your Typesense collection.
You can run the scraper manually or automate it (e.g. via GitHub Actions) so that your search index stays up-to-date as your docs evolve.
Check out the Getting Started Guide to add Typesense search to your Starlight site quickly.
Licensed under the MIT License, Copyright © Typesense.
See LICENSE for more information.