From d2f414c5d38fba9b730291f9e6835077479e33a0 Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Mon, 12 Mar 2018 16:49:21 -0700 Subject: [PATCH] Add more docs for Algolia --- docs/api-site-config.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/api-site-config.md b/docs/api-site-config.md index 66448bef55..e3eb4fd017 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -63,7 +63,11 @@ headerLinks: [ ### Optional Fields -`algolia` - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. +`algolia` - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (`appId`) is optional. + +- `apiKey` - the Algolia provided API key for your search. +- `indexName` - the Algolia provided index name for your search (usually this is the project name) +- `appId` - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them. `blogSidebarCount` - Control the number of blog posts that show up in the sidebar. See the [adding a blog docs](guides-blog.md#changing-how-many-blog-posts-show-on-sidebar) for more information.