I use Algolia Docsearch on this docs website. It is free to use on Algolia's Community plan, but you need to display Algolia's logo in your search console. Thank you Algolia! 🙏🏼
The official tutorial on how to self-host Algolia Docsearch can be found here. I use the crawler from the code base, but the Docker mode is probably easier.
When setting up the
pipenv, I had some trouble running
pipenv install. This command helped:
It was also helpful to change the required Python version in the Pipfile to the version I had. In my case, it was
You can create your config file using their bootstrap or create one based off of the Docusaurus v2 config file.
As a result, my
config.json is something like this:
If you have the
config.json file in your root directory, run:
Make sure you have the
./ indicates the current directory. Running
./docsearch run config.json without the
./ will not work.
When you put the Algolia information into your
docusaurus.config.js, make sure you put in the
appId as well as the
indexName. You can see what I mean in this pull request or this commit for the pull request.
A live example of how to configure Algolia in
docusaurus.config.js is available here: