From 4aa0c2c67a5ba4d5d786c63cbce749d674b8ce44 Mon Sep 17 00:00:00 2001 From: James Gray <101061708+randombeeper@users.noreply.github.com> Date: Thu, 11 Jul 2024 12:02:14 -0500 Subject: [PATCH] fix: updating the templates page (#2273) * 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 --- packages/website/docs/integrations.md | 6 +- packages/website/docs/templates.mdx | 91 ++++++++++++++------------- 2 files changed, 52 insertions(+), 45 deletions(-) diff --git a/packages/website/docs/integrations.md b/packages/website/docs/integrations.md index cf0b9a57a..39adc3ca6 100644 --- a/packages/website/docs/integrations.md +++ b/packages/website/docs/integrations.md @@ -12,7 +12,7 @@ So, if you're using one of the following tools, checkout their documentation to - [Docusaurus v2 & v3][3] - [Using Algolia DocSearch][4] - [VuePress][5] - [Algolia Search][6] - [VitePress][21] - [Search][22] -- [pkgdown][7] - [DocSearch indexing][8] +- [Starlight][7] - [Algolia Search][8] - [LaRecipe][9] - [Algolia Search][10] - [Orchid][11] - [Algolia Search][12] - [Smooth DOC][13] - [DocSearch][14] @@ -28,8 +28,8 @@ If you're maintaining a similar tool and want us to add you to the list, [feel f [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://pkgdown.r-lib.org/ -[8]: https://pkgdown.r-lib.org/articles/search.html#bootstrap-3-algolia +[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 diff --git a/packages/website/docs/templates.mdx b/packages/website/docs/templates.mdx index 4562899a5..7ceff0875 100644 --- a/packages/website/docs/templates.mdx +++ b/packages/website/docs/templates.mdx @@ -1,25 +1,22 @@ --- -title: Config templates +title: Config Templates --- import useBaseUrl from '@docusaurus/useBaseUrl'; -To help you create the best search experience for your users, we provide config templates for multiple websites generators. If you'd like to add a new template to our list, or believe we should update an existing one, please [send us an email][1] or [open a pull request][2]. +To help you create the best search experience for your users, we provide out-of-the-box crawler config templates for multiple websites generators. If you'd like to add a new template to our list, or believe we should update an existing one, please [let us know on Discord][1] or [open a pull request][2]. -> If you want to better understand the default parameters of the configs below, you can take a look at the [Crawler documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/). +> If you want to better understand the default parameters of the configs below, take a look at the [Crawler documentation](https://www.algolia.com/doc/tools/crawler/apis/configuration/). -## From the Crawler UI +## Getting Started -Templates are available when you [create a new Crawler](https://crawler.algolia.com/admin/crawlers/create). They will automatically be filled with your website URL, Algolia credentials and index name. +Once approved for DocSearch, we will automatically create a Crawler on your behalf, include your URL, and the Algolia creditials for your appId, apiKey, and indexName. If we detected that you are using any of the predefined generators, we'll attempt to automatically assign the proper template that matches your generator. However, this is not gauranteed. If no specific generator is detected, we will apply the default template seen below. -