question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

New docs: configure Algolia DocSearch

See original GitHub issue

Algolia DocSearch support is included implicitly in the package @docusaurus/preset-classic, but not active. It requires the algolia options object to be present in docusaurus.config.js as shown below.

This seems to be done either by submitting a PR against Algolia’s public list of DocSearch indexes, or by submitting this form https://docsearch.algolia.com/apply/

Reference: Connecting Algolia.

module.exports = {
  themeConfig: {
    algolia: {
      apiKey: 'YOUR_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      searchParameters: {}, // Optional (if provided by Algolia)
    },
  },
  themes: [
    ['@docusaurus/theme-search-algolia', {}],
  ],
};

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:35 (20 by maintainers)

github_iconTop GitHub Comments

4reactions
m-vdbcommented, Oct 6, 2020

latest update:

  • it works on Rasa SDK ✅
  • for some reason it doesn’t work on Rasa X and Rasa 🔴
    • Rasa X behavior: no results
    • Rasa behavior: results from Rasa and Rasa X are mixed up

Continuing the conversation with their support, we should get an answer today or tomorrow for Rasa X.

2reactions
lunelsoncommented, Aug 20, 2020

@akelad It’s Sylvain, yes. He finally clued me in today to what was missing: the search is not configured through our account at Algolia (though it is listed there, in the sidebar); it is configured through a JSON file in their public repo:

This is of course out of date now, so we need to do a PR to remove that JSON and create two new ones, one for each of the new sites; however this can’t be done until their baseUrl settings are final (without the /next/ addition).

CC @m-vdb

Read more comments on GitHub >

github_iconTop Results From Across the Web

DocSearch: Search made for documentation ... - Algolia
The easiest way to add search to your documentation - Powered by Algolia.
Read more >
Config Files | DocSearch by Algolia
When using the free DocSearch crawler, the indexName will always be the name of the configuration file. If you're running DocSearch yourself ...
Read more >
Required configuration | DocSearch by Algolia
You can find the default DocSearch config template below and tweak it with some examples from our complex extractors section.
Read more >
Getting Started | DocSearch by Algolia
DocSearch v3 is built on top of the latest version of Algolia Autocomplete, which provides better accessibility, increased responsiveness, ...
Read more >
Config templates | DocSearch by Algolia
To help you create the best search experience for your users, we provide config templates for multiple websites generators.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found