Docsbook
Aperçu

Activer la recherche en texte intégral

Docsbook indexe chaque page markdown dans votre dépôt et peut exposer cet index à deux endroits : un bouton de recherche dans l'en-tête et une zone de recherche dans la barre latérale gauche. La recherche des lecteurs ne coûte rien à votre solde de projet — elle interroge un index que Docsbook a déjà construit.

Activer le bouton de recherche dans l'en-tête#

  1. Ouvrez votre site de documentation tout en étant connecté.
  2. Ouvrez Float Widget → Design → onglet Header.
  3. Activez le bouton de recherche.
  4. Cliquez sur Enregistrer.

Le bouton apparaît dans la barre supérieure de chaque page.

  1. Ouvrez votre site de documentation tout en étant connecté.
  2. Ouvrez Float Widget → Design → l'onglet Barre latérale gauche.
  3. Activez Recherche dans la barre latérale.
  4. Cliquez sur Enregistrer.

La boîte apparaît au-dessus de l'arbre de navigation dans le panneau de gauche.

Choisissez où se trouve la zone de recherche#

Les deux emplacements peuvent fonctionner en même temps. Activer l'un est généralement suffisant.

Placement Idéal pour Compromis
En-tête Visiteurs de première fois, qui regardent d'abord la barre supérieure Concurrence pour l'espace avec vos liens d'en-tête
Barre latérale Lecteurs qui naviguent déjà par l'arbre Caché sur les écrans étroits où la barre latérale se replie

Si votre en-tête contient déjà plusieurs liens, utilisez la recherche dans la barre latérale au lieu d'ajouter un autre contrôle à la barre supérieure.

Quels index de recherche Docsbook#

La recherche en texte intégral de Docsbook couvre chaque fichier markdown publié par le site, et l'index est reconstruit lorsque votre dépôt change sur GitHub. Il n'y a rien à réindexer manuellement.

Correspondances de recherche :

  • Titres de page
  • Sous-titres
  • Texte du corps
  • Blocs de code, classés en dessous de la prose

La recherche par mot-clé s'exécute contre cet index et n'appelle jamais un modèle d'IA, donc elle ne puise pas dans votre solde de projet. La recherche sémantique — correspondant par signification plutôt que par mot-clé — appelle un modèle, et est facturée contre le solde comme toute autre utilisation de l'IA.

Étapes suivantes#

Mettez la recherche devant vos lecteurs

Chaque nouveau projet commence avec un solde de 1 $, et la recherche des lecteurs ne le dépense pas.

Updated

Cette page vous a-t-elle été utile ?