A VitePress plugin that adds Typesense DocSearch for fast, typo-tolerant documentation search.
npm install vitepress-plugin-typesenseA VitePress plugin that integrates Typesense with the DocSearch interface to add lightning-fast, typo-tolerant search to your VitePress documentation site.
Check out the Getting Started Guide to add Typesense search to your VitePress site quickly.
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.
VitePress is a Static Site Generator (SSG) designed for building fast, content-centric websites.
Together, Typesense, VitePress and DocSearch provide a seamless way to add powerful, blazingly-fast search to modern websites.
To enable search, your documentation content must be indexed into Typesense. You can choose between two methods:
- Built-in Indexing (Recommended):
The plugin automatically scans your generated HTML files and indexes them into Typesense whenever you run vitepress build. This is the easiest setup as it requires no external tools.
- External Scraper:
You can use the official typesense-docsearch-scraper. This is a crawler that visits your live documentation, extracts content (titles, headings, paragraphs), and pushes it to Typesense. This approach requires an automation pipeline (e.g., GitHub Actions).
Licensed under the MIT License, Copyright © Typesense.
See LICENSE for more information.