Boost de recherche

Orientez le classement de la recherche intégrée à votre site de documentation vers des pages ou sections spécifiques en définissant un multiplicateur de boost dans le frontmatter ou dans la navigation de votre docs.json.

Utilisez boost pour orienter le classement de la recherche intégrée pour des pages ou sections spécifiques. La valeur est un multiplicateur numérique appliqué au score de pertinence de chaque fragment : boost: 3 rend un fragment trois fois plus pertinent qu’il ne le serait sans boost.

boost n’affecte que la barre de recherche de votre site de documentation hébergé par Mintlify. Cela ne change pas la façon dont les moteurs de recherche externes indexent vos pages.

​

Booster une seule page

Définissez boost dans le frontmatter d’une page pour multiplier son classement dans la recherche.

---
title: "Custom domain"
description: "Connect your custom domain to your Mintlify documentation."
boost: 3
---

​

Booster un groupe de navigation

Définissez boost sur un groupe dans la navigation de votre docs.json pour appliquer le multiplicateur à chaque page qu’il contient.

{
  "navigation": {
    "groups": [
      {
        "group": "Get started",
        "boost": 5,
        "pages": [
          "quickstart",
          "concepts"
        ]
      }
    ]
  }
}

Une page hérite du facteur de boost de son ancêtre le plus proche qui en définit un. Une page enfant ou un groupe imbriqué peut remplacer le boost hérité en définissant sa propre valeur boost. Le boost du frontmatter d’une page l’emporte toujours sur une valeur héritée de la navigation.

​

Dé-prioriser du contenu

Utilisez une valeur inférieure à 1 pour reléguer les pages plus bas dans les résultats de recherche. Par exemple, boost: 0.5 réduit de moitié le score de pertinence d’une page par rapport aux autres pages. Un boost de 1 équivaut à l’absence de boost.

---
title: "Deprecated API"
description: "Documentation for the deprecated v1 API."
boost: 0.25
---

Les facteurs de boost se combinent avec le score de pertinence existant. Utilisez-les avec parcimonie. Des multiplicateurs élevés peuvent faire en sorte que des pages moins pertinentes dominent les résultats de recherche et dégradent la qualité globale de la recherche.

​

Définir le nombre maximal de résultats de recherche

Contrôlez le nombre de résultats renvoyés par la barre de recherche intégrée en définissant Max results dans votre tableau de bord, sous Settings > Search. La valeur doit être un entier compris entre 1 et 100. Par défaut, Mintlify renvoie jusqu’à six résultats.

Augmentez cette valeur lorsque votre documentation couvre de nombreux sujets connexes et que les utilisateurs gagnent à voir davantage de correspondances à la fois. Réduisez-la pour garder la liste de résultats ciblée et limiter le bruit visuel.

Ce paramètre n’affecte que la barre de recherche de votre site de documentation hébergé par Mintlify. L’API de recherche continue de respecter le paramètre pageSize de chaque requête, qui l’emporte sur le paramètre du tableau de bord lorsqu’il est fourni.