docusaurus: Algolia search results PAGE not returning any results

Finally, I was able to solve it! Even though I followed exactly the steps provided by @elitan in this answer, including deleting the index, using the template v2, reindexing, enabling contextualSearch, and redeploying, the problem persisted.

Eventually, I realized that despite these steps and the presence of the fields in my crawler settings, the attributesForFaceting configuration in the index was actually not populated correctly (🤷‍♂️). So, I manually added the required fields in the UI and initiated a reindexing, which ultimately resolved the issue.

Thanks. I got it working. I did some permutation of steps. But in the end, I think these were the steps:

1. Delete the current index (nhost).
2. Copied the v2 config from https://docsearch.algolia.com/docs/templates/#docusaurus-v2-template. Updated with appName, apiKey, and index name (nhost).
3. Re-run crawler (will create the index for me).
4. Redeployed my Docusaurus site.

We were able to get our modal and /search page working! 🎉

Thanks everyone for your help! @slorber @shortcuts

Are you using your own crawler our the Algolia Crawler?

The contextualSearch option requires a few things to work:

• Having docusaurus_tag, version and language in the attributesForFaceting (see Docusaurus v2 config template)
• The steps describe in Algolia search results PAGE not returning any results #6693 (comment)

Feel free to provide more infos about your crawler/Algolia app, I’ll check if the steps above doesn’t help.

@shortcuts @slorber Oh my goodness, thank you both so much for this fix! I was facing the same issues as the others here and stumbled upon this thread. Both my modal and search page are working now. 🥳

Hey,

As @slorber said, the issue is that the search plugin was not enabled before crawling your website, which make contextualSearch unusable.

To solve your issue:

1. Keep your search plugin enabled
2. Enable contextualSearch
3. Start a new crawl from the crawler interface https://crawler.algolia.com/
4. Enjoy searching from both the modal and the search page 😄

because the search page somehow always use contextual search (we’ll change that)

It would indeed be nice to make it follow the config value

No search result?

For anyone passing by, if you don’t get any Algolia search results:

• make sure that your Algolia index has the fields in the screenshot below
• If you don’t see these fields, then you have an index config problem
• You should check your crawler config, make sure it matches the recommended one, and then delete/recreate your index based on the newly updated/fixed crawler config (Algolia team recommendation)

See also: https://github.com/facebook/docusaurus/discussions/10007#discussioncomment-9021352

Note: contextual search is enabled by default now.

In Docusaurus v1, or in older versions of Docusaurus v2, there was no “attributesForFaceting. docusaurus_tag” in the crawler config. This lead to contextual search not working.

You can see contextual search is not working if:

• the /search page is not working (always)
• the modal search is not working with contextualSearch: true, but works with contextualSearch: false

That looks to be the case here, so you’ll need to fix the Crawler, and ensure Docusaurus can filter on the “docusaurus_tag” field (metadata that we put in your pages for filtering).

If you can’t see “docusaurus_tag” anywhere in the Algolia dashboard, that’s a sign that your index probably has a bad configuration

Hey @elitan, initialIndexSettings are applied at index creation time only, so you might need to delete your index from the Algolia dashboard (https://www.algolia.com/apps/YOUR_APP_ID/dashboard) and restart a crawl, everything should work after this.

Was your config deploy without the Docusaurus v2 default template? Or have you migrated to Docusaurus v2 after the DocSearch instance have been deployed? (Checking if the issue come from our deploy process)

thanks @shortcuts and @slorber, I can confirm the steps you described solved the issues. contextual works now on both modal & page 🔥

Hey @huynhicode,

Are you using your own crawler our the Algolia Crawler?

The contextualSearch option requires a few things to work:

• Having docusaurus_tag, version and language in the attributesForFaceting (see Docusaurus v2 config template)
• The steps describe in https://github.com/facebook/docusaurus/issues/6693#issuecomment-1041545752

Feel free to provide more infos about your crawler/Algolia app, I’ll check if the steps above doesn’t help.

Hi everyone, James from Algolia chiming in since this is a regular question and this issue is regularly referenced.

The first time the crawler runs, the initialIndexSettings in the crawler configuration file will be used but on subsequent runs it will not be, thus the name. If you want to change the index settings, delete the index with the name specified under initialIndexSettings. The next time the crawler runs the attributes will be populated and then the facetFilters being used by Docusaurus will match up.

Algolia has a discord channel dedicated to DocSearch, come join us there if you have more questions: Discord

Yes faced similar issue. I use V3 and my algolia docsearch got approved today. I was first facing issue

1. Had to use crawler config from v3 template
2. In docusaurus config I have contextualSearch: true my config
3. Delete existing index and retrigger crawling
4. Now both search and modal works perfectly fine.

ignoreCanonicalTo: true in the crawler config is critical else pages were getting ignored.

My website for reference https://k3s-simplified.easystartup.io/

Following the comments here was able to get this to work after updating my Crawler to use the v3 config. I applied for the open source program so the crawler was created for me with the wrong config settings.

I updated it based on their site to use the v3 config but still ran into issues. The problem I had was I was initializing the index myself and letting the crawler fill it.

The fix was to let the crawler create the index for me because there are settings it fills only on initial creation. I found that by re-reading thru this issue and found this comment: https://github.com/facebook/docusaurus/issues/6693#issuecomment-1158568333

I have the same issue. Our search is working in the dialog but not on the full page.

I’m working on a fix here: https://github.com/nhost/nhost/pull/716 and tried to follow the steps in this issue:

1. Enabled contextualSearch (see PR above)
2. Updated the Algolia crawler config:

  initialIndexSettings: {
    nhost: {
      attributesForFaceting: [
        "type",
        "lang",
        "language",
        "version",
        "docusaurus_tag",
      ],
      attributesToRetrieve: [
        "hierarchy",
        "content",
        "anchor",
        "url",
        "url_without_anchor",
        "type",
      ],

1. Deployed a preview environment: https://docs-git-docs-algolio-fix-nhost.vercel.app/

Result: Search stopped working in the modal. The full-page search still does not work.

Could someone hint me in the right direction to fix this?

@slorber Search works in the modal consistently. This also seems to be the same issue reported in #5084 Are you suggesting that for the same term working in modal, not working in page, can be related to crawling?

/cc @lex111 We may need to revamp the search page, now that you are already working on #6692.

We’ll keep it open because of that contextualSearch issue. cc @shortcuts as well, if we can get any input on your side.

Since I’m not familiar with Algolia at all, not much input on my side🤷‍♂️

Indeed duplicate (GH issue search sucks)

The in:title query is your friend, especially if you want to navigate around larger repositories like the TypeScript repo with 5000+ issues. #5084 is not very easy to find because it’s not searchable through search page in:title, but it is through algolia request in:title, since you already realized it has something to do with the request shape.