From 8359ff36cd6f44e4fa58e836d95ccf26e6890324 Mon Sep 17 00:00:00 2001 From: Can Olcer Date: Thu, 25 Nov 2021 13:03:32 +0100 Subject: [PATCH] docs: improve algolia integration instructions (#6008) * docs: improve algolia integration instructions The current version makes it look like you need to install `@docusaurus/theme-search-algolia` on top the classic version to work, but it already works with the classic version. Adding `@docusaurus/theme-search-algolia` on top leads to errors. * Still document installation * Do not make separate paragraph Co-authored-by: Josh-Cena --- website/docs/search.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/website/docs/search.md b/website/docs/search.md index 6b7c040152..bba3d8c8ff 100644 --- a/website/docs/search.md +++ b/website/docs/search.md @@ -58,14 +58,32 @@ It is highly recommended using a config similar to the [**Docusaurus 2 website c ### Connecting Algolia {#connecting-algolia} -Docusaurus' own `@docusaurus/preset-classic` supports an Algolia DocSearch integration. +Docusaurus' own `@docusaurus/preset-classic` supports Algolia DocSearch integration. If you use the classic preset, no additional installation is needed. -To connect your docs with Algolia, first add the package to your website: +
+Installation steps when not using @docusaurus/preset-classic + +1. Install the package: ```bash npm2yarn npm install --save @docusaurus/theme-search-algolia ``` +2. Register the theme in `docusaurus.config.js`: + +```js title="docusaurus.config.js" +module.exports = { + title: 'My site', + // ... + themes: ['@docusaurus/theme-search-algolia'], + themeConfig: { + // ... + }, +}; +``` + +
+ Then, add an `algolia` field in your `themeConfig`. **[Apply for DocSearch](https://docsearch.algolia.com/apply/)** to get your Algolia index and API key. ```jsx title="docusaurus.config.js"