4aa0c2c67a
* fix: updating the templates page The templates page needs some work. The first thing I saw is that it alluded to being able to create a crawler. As a docsearch user, this is confusing. We automatically create a crawler for the user, additional crawlers get confusing for the user. Provide additional information about updating templates, as we're talking about templates here. Verify the current templates, I see the default one isn't quite right. Given that we use the same template for Docusaurus v2 and v3 combine those. Add the Starlight template. * Combined Docusaurus v2 and v3 templates Its confusing to have two separate sections that are exactly the same * added astro starlight template * remove pkgdown and add starlight pkgdown no longer references Algolia added starlight as an integration partner
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
|