19c1ef9192
* feat(v4): add new UI (#2555) * feat: add new footer ui * feat: add new search box ui * feat: add searchbox actions * feat: add start screen * feat: add no results screen * feat: add new card ui * feat: add new icons * feat: add new key press class * fix: cypress tests * fix: circleci * fix: circleci * fix: close aria label * fix: circleci * fix: remove unused classes * fix: circleci * feat: update version * feat: add new dark mode ui * fix: colors * fix: design review * fix: hit title length * fix: improve accessibility * fix: ci * chore: increase bundle size threshold * fix: css * feat(v4): ask-ai foundations ✨ (#2574) * feat(v4): docsearch askAI context (#2587) * fix(v4): ask ai updates (#2654) * feat(v4): update beta documentation (#2659) * chore: release v4.0.0-beta.0 (#2660) * fix: make release run on branches like v4 * chore: release v4.0.0-beta.0 * hotfix: closing on askai error * chore: release v4.0.0-beta.1 (#2661) * fix: add a section on models * fix: update to `<package>@beta` * feat(docsearch-website): Updated docs (#2662) * feat(v4): update the landing page (#2665) * fix: beta in readme * feat: added glow around the search bar and a little copy above the keyboard * feat: add glow around the search bar and copy above the keyboard * fix: Add more styling * fix: polishing v4 (#2667) * chore: release v4.0.0-beta.2 (#2668) * fix: update docusaurus tarballs * fix(website): update docusaurus tarballs * fix: mobile search bar --------- Co-authored-by: Vasco Bettencourt <32492444+vascobettencourt@users.noreply.github.com> Co-authored-by: Natan Yagudayev <natanyagudayev@gmail.com>
44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
---
|
|
title: Supported Integrations
|
|
---
|
|
|
|
We worked with **documentation website generators** to have DocSearch directly embedded as a first class citizen in the websites they produce.
|
|
|
|
## Our great integrations
|
|
|
|
So, if you're using one of the following tools, checkout their documentation to see how to enable DocSearch on your website:
|
|
|
|
- [Docusaurus v1][1] - [How to enable search][2]
|
|
- [Docusaurus v2 & v3][3] - [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're maintaining a similar tool and want us to add you to the list, [feel free to make 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/). We're happy to help.
|
|
|
|
[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
|