Translate

Enabling Search

Docusaurus prend en charge la recherche en utilisant Algolia DocSearch. Une fois que votre site est en ligne, vous pouvez le soumettre à DocSearch. Algolia vous enverra alors les identifiants que vous pourrez ajouter à votre siteConfig.js.

DocSearch travaille en explorant le contenu de votre site Web toutes les 24 heures et en mettant tout le contenu dans un index Algolia. Ce contenu est ensuite interrogé directement depuis votre front-end en utilisant l'API Algolia. Notez que votre site Web doit être accessible au public pour que cela fonctionne (par exemple pas derrière un pare-feu). Ce service est gratuit.

Activation de la barre de recherche

Entrez votre clé API et le nom de l'index (envoyé par Algolia) dans siteConfig.js dans la section algolia pour activer la recherche de votre site.

const siteConfig = {
  ...
  algolia: {
    apiKey: 'my-api-key',
    indexName: 'my-index-name',
    appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
    algoliaOptions: {} // Optional, if provided by Algolia
  },
  ...
};

Options de recherche supplémentaires

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Cela peut être utile si vous voulez fournir des résultats de recherche différents pour les différentes versions ou langues de vos docs. Toutes les occurrences de "VERSION" ou "LANGUAGE" seront remplacées respectivement par la version ou la langue de la page courante. Plus de détails sur les options de recherche peuvent être trouvés ici.

const siteConfig = {
  ...
  algolia: {
    ...
    algoliaOptions: {
      facetFilters: [ "language:LANGUAGE", "version:VERSION" ]
    }
  },
};

Algolia might provide you with extra search options. Si c'est le cas, vous devriez les ajouter à l'objet algoliaOptions.

Contrôle de l'emplacement de la barre de recherche

Par défaut, la barre de recherche sera l'élément le plus à droite de la barre de navigation supérieure.

Si vous voulez changer l'emplacement par défaut, ajoutez l'option searchBar dans le champ headerLinks de siteConfig.js à l'emplacement souhaité. Par exemple, vous souhaitez peut-être que la barre de recherche se trouve entre vos liens internes et externes.

const siteConfig = {
  ...
  headerLinks: [
    {...}
    {...}
    { search: true }
    {...}
    {...}
  ],
  ...
};

Personnalisation du placeholder

Si vous souhaitez modifier le placeholder (dont la valeur par défaut est Search), ajoutez le champ placeholder dans votre configuration. Par exemple, vous pouvez vouloir que la barre de recherche affiche Demandez-moi quelque chose :

const siteConfig = {
  ...
  algolia: {
    ...
    placeholder: 'Demandez-moi quelque chose'
  },
};

Désactivation de la barre de recherche

Pour désactiver la barre de recherche, commentez (recommandé) ou supprimez la section algolia dans le fichier siteConfig.js.

Aussi, si vous avez personnalisé l'emplacement de la barre de recherche dans headerLinks, définissez search: false.