fix(docs): mention that appID is optional

facebook · Apr 25, 2020 · cd2d23a · cd2d23a
1 parent fed12e4
commit cd2d23a
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/website/docs/search.md b/website/docs/search.md
@@ -16,7 +16,7 @@ Algolia DocSearch works by crawling the content of your website every 24 hours a
 
 ### Connecting Algolia
 
-To connect your docs with Algolia, add an `algolia` field in your `themeConfig`. Note that you will need algolia API key and algolia index. You can [apply for DocSearch here](https://community.algolia.com/docsearch/).
+To connect your docs with Algolia, add an `algolia` field in your `themeConfig`. Note that you will need algolia API key and algolia index. You can [apply for DocSearch here](https://docsearch.algolia.com/apply/).
 
 ```jsx title="docusaurus.config.js"
 module.exports = {
@@ -25,9 +25,9 @@ module.exports = {
     // ...
     // highlight-start
     algolia: {
-      appId: 'app-id',
       apiKey: 'api-key',
       indexName: 'index-name',
+      appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
       algoliaOptions: {}, // Optional, if provided by Algolia
     },
     // highlight-end

diff --git a/website/versioned_docs/version-2.0.0-alpha.48/search.md b/website/versioned_docs/version-2.0.0-alpha.48/search.md
@@ -20,14 +20,16 @@ To connect your docs with Algolia, add an `algolia` field in your `themeConfig`.
 
 ```jsx {4-9}
 // docusaurus.config.js
-themeConfig: {
-    // ....
+  themeConfig: {
+    // ...
+    // highlight-start
     algolia: {
-      appId: 'app-id',
       apiKey: 'api-key',
       indexName: 'index-name',
+      appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
       algoliaOptions: {}, // Optional, if provided by Algolia
     },
+    // highlight-end
   },
 ```
 

diff --git a/website/versioned_docs/version-2.0.0-alpha.50/search.md b/website/versioned_docs/version-2.0.0-alpha.50/search.md
@@ -19,14 +19,16 @@ Algolia DocSearch works by crawling the content of your website every 24 hours a
 To connect your docs with Algolia, add an `algolia` field in your `themeConfig`. Note that you will need algolia API key and algolia index. You can [apply for DocSearch here](https://community.algolia.com/docsearch/).
 
 ```jsx {3-8} title="docusaurus.config.js"
-themeConfig: {
+  themeConfig: {
     // ...
+    // highlight-start
     algolia: {
-      appId: 'app-id',
       apiKey: 'api-key',
       indexName: 'index-name',
+      appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
       algoliaOptions: {}, // Optional, if provided by Algolia
     },
+    // highlight-end
   },
 ```