3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 00:39:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #54 from facebookexperimental/search-doc-options

Browse source 
Update search guide
This commit is contained in:
Frank Li 2017-08-10 12:24:51 -07:00 • committed by GitHub
commit 0fc7704a56
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/guides-search.md
View file

@ -20,6 +20,20 @@ const siteConfig = {
}
```
### Extra Search Options
You can also specify extra [search options used by Algolia](https://community.algolia.com/docsearch/documentation/) by using an `algoliaOptions` field in `algolia`. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be [found here](https://www.algolia.com/doc/api-reference/api-parameters/#overview).
```js
const siteConfig = {
...
algolia: {
...
algoliaOptions: '{ facetFilters: [ "tags:VERSION" ], hitsPerPage: 5 }'
},
}
```
### Controlling the Location of the Search Bar
By default, the search bar will be the rightmost element in the top navigation bar.