Typesense Guide

The guide section of the documentation walks you through how to use Typesense in different scenarios.

For a high-level overview of Typesense, what you can use it for, and some live-demos, read the Overview section. For a detailed dive into the Typesense API, refer to our <RouterLink :to="`/${$site.themeConfig.typesenseLatestVersion}/api/`"><strong>API Documentation</strong></RouterLink>.

Quick Start

For a quick step-by-step walk-through, follow these articles in the order below:

1. Skim through Typesense's key Use-Cases (It's much more than full text search) and Live Demos
2. Install Typesense
3. Install a Client Library
4. Build a Search Application
5. Build a Search UI
6. If you're an Algolia user, follow the Migrating from Algolia guide
7. For documentation site search, follow the DocSearch guide
8. Review Best Practices

Read through the rest of the guide using the links in the left-side pane.

For a detailed dive into the Typesense API, refer to our <RouterLink :to="`/${$site.themeConfig.typesenseLatestVersion}/api/`"><strong>API Documentation</strong></RouterLink>.

Getting Help

We've strived to keep Typesense as self-service and out-of-the-box as possible, with fully public documentation.

But if you have any questions, here are some ways to get additional help:

• Read through our Frequently Asked Questions or browse through the nav bar on the left-pane in our Guide for relevant articles - we've put these articles together based on feedback from several users.
• Use GitHub's native search to search through past conversations in our GitHub issue tracker.
• Browse and search through past conversations in our Slack community.
• Open a GitHub issue with any questions or bug reports.
• Join our public Slack community to discuss general questions and/or issues.
• Schedule a call with a member of the core Typesense team, by sponsoring Typesense on GitHub and picking the appropriate one-time sponsorship tier, and email us at contact at typesense dot org
• We also offer prioritized paid support, with private Slack, email & phone-based support with guaranteed SLAs on Typesense Cloud. Learn more here.

---

:::tip Navigation Tip Use the links on the left side pane and top navigation bar to get to the appropriate section you're looking for.

Or use the search bar on the top of the page, which coincidentally is powered by Typesense. :::

This documentation itself is open source. If you find any issues, click on the Edit page button at the bottom of the page and send us a Pull Request.

<RedirectOldLinks />