Adaptateur Docusaurus (Recommandé)

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Si vous utilisez Docusaurus, installez et configurez @docsearch/docusaurus-adapter pour bénéficier des dernières fonctionnalités de DocSearch sur votre version actuelle de Docusaurus.

Pourquoi cet adaptateur existe

Docusaurus propose une excellente intégration native d'Algolia (@docusaurus/theme-search-algolia), mais les cycles de publication de Docusaurus (maintenu par Meta) et de DocSearch ne sont pas toujours synchronisés.

L'adaptateur DocSearch nous permet de déployer de nouvelles fonctionnalités (dont le support du panneau latéral Ask AI) sans vous forcer à attendre une mise à jour de l'intégration Docusaurus.

Concrètement, cela signifie :

• Accès plus rapide aux nouvelles fonctionnalités de DocSearch.

• Meilleure compatibilité avec les fonctionnalités Ask AI + panneau latéral.

• Une voie d'intégration dédiée maintenue dans le projet DocSearch.

Installation

yarn add @docsearch/docusaurus-adapter
# or
npm install @docsearch/docusaurus-adapter

Configuration

Conservez @docusaurus/preset-classic, ajoutez le plugin adaptateur, et configurez la recherche sous themeConfig.docsearch (méthode recommandée) :

docusaurus.config.mjs

export default {
  plugins: ['@docsearch/docusaurus-adapter'],
  themeConfig: {
    docsearch: {
      appId: 'YOUR_APP_ID',
      apiKey: 'YOUR_SEARCH_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      askAi: {
        assistantId: 'YOUR_ASSISTANT_ID',
        sidePanel: true,
      },
      contextualSearch: true,
    },
  },
};

Clés docsearch vs algolia

• themeConfig.docsearch est la clé canonique.

• themeConfig.algolia est pris en charge comme alias pour la rétrocompatibilité.

• Ne définissez pas les deux clés simultanément.

Utiliser themeConfig.docsearch évite les conflits de validation avec le thème de recherche natif de Docusaurus lorsque vous souhaitez utiliser des options récentes comme askAi.sidePanel.

Personnalisation de l'interface de recherche (SearchBar/SearchPage)

Pour personnaliser le comportement ou l'interface de recherche, modifiez les composants thématiques de l'adaptateur (@theme/SearchBar et @theme/SearchPage) via le chemin d'intégration de l'adaptateur.

Cela maintient vos personnalisations alignées sur les mises à jour de DocSearch et évite le couplage avec l'implémentation native du thème Algolia de Docusaurus.