docs.json pour contrôler comment les moteurs de recherche indexent votre documentation, quelles métadonnées apparaissent dans les résultats de recherche, comment la barre de recherche se comporte et si les pages affichent un horodatage de dernière modification.
Paramètres
description
Type : string
Une description de votre site de documentation pour le SEO et l’indexation par l’IA. Elle apparaît dans les résultats des moteurs de recherche et les outils d’IA l’utilisent pour comprendre l’objectif de votre site.
docs.json
seo
Type : object
Paramètres d’indexation et de métadonnées pour les moteurs de recherche.
"navigable" | "all"
Spécifie quelles pages les moteurs de recherche doivent indexer.
navigable—Indexer uniquement les pages incluses dans la navigation de votredocs.json. C’est la valeur par défaut.all—Indexer toutes les pages de votre projet, y compris les pages qui ne sont pas dans la navigation.
object
Balises meta personnalisées ajoutées à chaque page. Fournies sous forme de paires clé-valeur où chaque clé est un nom de balise meta et la valeur est son contenu.Voir référence des balises meta courantes pour les options disponibles.
array
Balises meta limitées à un dossier. Utilisez ce champ pour appliquer des balises différentes à un sous-ensemble de pages, comme une documentation versionnée ou un domaine produit spécifique, sans les répéter dans le frontmatter de chaque page.Chaque entrée contient :
path: Chemin de dossier relatif à la racine de la documentation, commeguides/v2, sans barre oblique au début ni à la fin. S’applique à toutes les pages sous ce dossier. Chaque chemin ne peut apparaître qu’une seule fois.metatags: Balises meta ajoutées à chaque page souspath, sous forme de paires clé-valeur. Les valeurs doivent être des chaînes non vides.
seo.metatags, puis les entrées de seo.paths correspondantes (les chemins plus longs l’emportent sur les plus courts lorsqu’une page est incluse dans plusieurs), puis le frontmatter de la page.Les chemins sont comparés aux URL des pages : les pages traduites dans un dossier de langue ont donc besoin de leurs propres entrées. Par exemple, guides/v1 ne s’applique pas à fr/guides/v1.Mintlify ignore la clé canonical dans les entrées de seo.paths. Définissez une URL canonique pour tout le site dans seo.metatags ou une URL canonique par page dans le frontmatter.object
Organisation utilisée comme entité éditrice dans les données structurées émises sur chaque page. Tous les champs sont facultatifs. Lorsqu’ils sont omis, Mintlify dérive l’organisation du nom de votre site, du logo de la documentation et de l’URL du site.
id—URL@idstable qui identifie votre organisation sur toutes les pages, par exemplehttps://example.com/#organization. Par défaut,<origine du site>/#organization.name—Nom de l’organisation. Par défaut, le nom du site.legalName—Nom légal enregistré.url—URL canonique de la page d’accueil de l’organisation.logo—URL canonique du logo utilisée dans les données structurées. Par défaut, le logo de la documentation.sameAs—Tableau d’URLs de profils officiels, comme X, LinkedIn ou GitHub.
docs.json
search
Type : object
Paramètres d’affichage de la barre de recherche.
string
Texte d’espace réservé affiché dans la barre de recherche lorsqu’elle est vide.
docs.json
metadata
Type : object
Paramètres de métadonnées au niveau de la page appliqués globalement à toutes les pages.
boolean
Affiche une date de dernière modification sur toutes les pages. Lorsqu’elle est activée, chaque page affiche la date de la dernière modification de son contenu. Valeur par défaut :
false.Vous pouvez remplacer ce paramètre pour des pages individuelles en utilisant le champ frontmatter timestamp. Voir Pages pour plus de détails.docs.json
Exemple
docs.json