SEO et recherche
Configurez le SEO dans docs.json : description du site, indexation par les moteurs de recherche, balises meta, placeholder de barre de recherche et horodatages.
Utilisez ces paramètres dans votre fichier 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.
"description": "Documentation pour l'API et la plateforme développeur d'Example Co."seo
Type : object
Paramètres d’indexation et de métadonnées pour les moteurs de recherche.
seo.indexing"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.
seo.metatagsobjectBalises 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.
"metatags": {
"og:site_name": "Example Co. Docs",
"twitter:card": "summary_large_image"
}seo.organizationobjectOrganisation 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.
"organization": {
"id": "https://example.com/#organization",
"legalName": "Example Co. Inc.",
"url": "https://example.com",
"logo": "https://example.com/images/logo.png",
"sameAs": [
"https://x.com/example",
"https://github.com/example"
]
}"seo": {
"indexing": "navigable",
"metatags": {
"og:site_name": "Example Co. Docs"
}
}search
Type : object
Paramètres d’affichage de la barre de recherche.
search.promptstringTexte d’espace réservé affiché dans la barre de recherche lorsqu’elle est vide.
"search": {
"prompt": "Rechercher dans la documentation..."
}metadata
Type : object
Paramètres de métadonnées au niveau de la page appliqués globalement à toutes les pages.
metadata.timestampbooleanAffiche 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.
"metadata": {
"timestamp": true
}Exemple
{
"description": "Documentation pour l'API et la plateforme développeur d'Example Co.",
"seo": {
"indexing": "navigable",
"metatags": {
"og:site_name": "Example Co. Docs",
"twitter:card": "summary_large_image"
}
},
"search": {
"prompt": "Rechercher dans la documentation..."
},
"metadata": {
"timestamp": true
}
}