Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/src/content/docs/guides/site-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -232,3 +232,34 @@ Add translations of the modal UI for your language using Starlight’s built-in
```

</Steps>

### Typesense DocSearch

If you prefer a self-hosted or open-source alternative to Algolia DocSearch, try the [Starlight DocSearch Typesense](https://github.com/typesense/starlight-docsearch-typesense) plugin.
It integrates the same DocSearch interface with a Typesense backend.

See the full documentation and setup guide at [starlight-docsearch.typesense.org](https://starlight-docsearch.typesense.org/getting-started).

```diff lang="js" ins={4,11-17}
// astro.config.mjs
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightDocSearchTypesense from 'starlight-docsearch-typesense'

export default defineConfig({
integrations: [
starlight({
title: 'Site with Typesense Search',
plugins: [
starlightDocSearchTypesense({
typesenseCollectionName: 'TYPESENSE_COLLECTION_NAME',
typesenseServerConfig: {
nodes: [{ url: 'TYPESENSE_SERVER_URL' }],
apiKey: 'TYPESENSE_SEARCH_ONLY_API_KEY',
},
}),
],
}),
],
})
```
5 changes: 5 additions & 0 deletions docs/src/content/docs/resources/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,11 @@ Extend your site with official plugins supported by the Starlight team and commu
title="starlight-github-alerts"
description="Render GitHub alerts as Starlight asides."
/>
<LinkCard
href="https://github.com/typesense/starlight-docsearch-typesense"
title="starlight-docsearch-typesense"
description="A Typesense-powered alternative to the official Algolia DocSearch plugin."
/>
</CardGrid>

## Community tools and integrations
Expand Down