46 lines
2.4 KiB
Markdown
46 lines
2.4 KiB
Markdown
---
|
|
title: Supported integrations
|
|
description: Find supported framework integrations for DocSearch.
|
|
---
|
|
|
|
Documentation frameworks can embed DocSearch in the websites they generate. A framework integration configures the frontend; your Algolia Crawler and index remain separate.
|
|
|
|
## Framework integrations
|
|
|
|
If you use one of the following tools, follow its documentation to enable DocSearch. Framework documentation can target a different DocSearch frontend release, so check its package compatibility before adopting v5.
|
|
|
|
- [Docusaurus v1][1] - [How to enable search][2]
|
|
- [Docusaurus v2 and v3][3] - [DocSearch v5 adapter][23] / [Using Algolia DocSearch][4]
|
|
- [VuePress][5] - [Algolia Search][6]
|
|
- [VitePress][21] - [Search][22]
|
|
- [Starlight][7] - [Algolia Search][8]
|
|
- [LaRecipe][9] - [Algolia Search][10]
|
|
- [Orchid][11] - [Algolia Search][12]
|
|
- [Smooth DOC][13] - [DocSearch][14]
|
|
- [Docsy][15] - [Configure Algolia DocSearch][16]
|
|
- [Lotus Docs][19] - [Enabling the DocSearch Plugin][20]
|
|
- [Sphinx](https://www.sphinx-doc.org/en/master/) - [Algolia DocSearch for Sphinx](https://sphinx-docsearch.readthedocs.io/)
|
|
|
|
If you maintain a similar tool and want us to add it to the list, [open a pull request](https://github.com/algolia/docsearch/edit/main/packages/website/docs/integrations.md) and [contribute to Code Exchange](https://www.algolia.com/developers/code-exchange/contribute/).
|
|
|
|
[1]: https://v1.docusaurus.io/
|
|
[2]: https://v1.docusaurus.io/docs/en/search
|
|
[3]: https://docusaurus.io/
|
|
[4]: https://docusaurus.io/docs/search#using-algolia-docsearch
|
|
[5]: https://vuepress.vuejs.org/
|
|
[6]: https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search
|
|
[7]: https://starlight.astro.build/
|
|
[8]: https://starlight.astro.build/guides/site-search/#algolia-docsearch
|
|
[9]: https://larecipe.saleem.dev/docs/2.2/overview
|
|
[10]: https://larecipe.saleem.dev/docs/2.2/search#available-engines
|
|
[11]: https://orchid.run
|
|
[12]: https://orchid.run/plugins/orchidsearch#algolia-docsearch
|
|
[13]: https://next-smooth-doc.vercel.app/
|
|
[14]: https://next-smooth-doc.vercel.app/docs/docsearch/
|
|
[15]: https://www.docsy.dev/
|
|
[16]: https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch
|
|
[19]: https://lotusdocs.dev/docs/
|
|
[20]: https://lotusdocs.dev/docs/guides/features/docsearch/#enabling-the-docsearch-plugin
|
|
[21]: https://vitepress.dev/
|
|
[22]: https://vitepress.dev/reference/default-theme-search#algolia-search
|
|
[23]: /docs/packages/docusaurus-adapter/getting-started
|