Algolia search

We use the powerful Algolia to search in the documentation. Algolia works like any other search engines: you have to create an index and its algorithm is capable to provide relevant hits in milliseconds.

#Building the index

Every time we release a new version of the documentation, an automatic script runs which sends the whole content of our documentation page to the Algolia index.

You can access the index, statistics, analytics and more on the Algolia Dashboard, you need to get access from the Stratus team.

#Local development

In order to make it work locally, you need to set an API key in your environment. Also, you have to set the Algolia app ID and the name of the Algolia index.

# /docs/site/.env

ALGOLIA_APP_ID=HABFF3VM7W
ALGOLIA_API_KEY=<your api key>
ALGOLIA_INDEX_NAME=stratus_docs
Copy