Passer au contenu principal
Mintlify prend automatiquement en charge de nombreuses bonnes pratiques SEO, notamment :
  • Génération de balises meta
  • Génération des fichiers sitemap et robots.txt
  • Structure HTML sémantique
  • Optimisation pour mobile
Vous pouvez entièrement personnaliser les balises meta de votre site en ajoutant le champ metatags à votre docs.json ou au frontmatter d’une page.

​
Balises meta générées automatiquement

Mintlify génère les balises meta suivantes pour chaque page. Vous pouvez les remplacer en les définissant dans votre docs.json ou dans le frontmatter d’une page. Métadonnées de base :
  • charset: utf-8 - Encodage des caractères
  • og:type: website - Type Open Graph
  • og:site_name - Nom de votre site de documentation
  • twitter:card: summary_large_image - Type de carte Twitter
Métadonnées spécifiques à la page :
  • title - Titre de la page, au format « Titre de la page - Nom du site »
  • og:title - Titre Open Graph, identique au titre de la page
  • twitter:title - Titre Twitter, identique au titre de la page
  • description - Description de la page
  • og:description - Description Open Graph, identique à la description de la page
  • twitter:description - Description Twitter, identique à la description de la page
URL et canonique :
  • canonical - Généré automatiquement à partir de l’URL de la page
  • og:url - Définie sur l’URL canonique
SEO et indexation :
  • robots - Généré à partir des métadonnées de la page
  • noindex - Généré à partir des métadonnées de la page
  • keywords - Généré à partir des métadonnées de la page
Images :
  • og:image - Image Open Graph, og:image:width défini à 1200 et og:image:height à 630
  • twitter:image - Image Twitter, twitter:image:width défini à 1200 et twitter:image:height à 630
Métadonnées du navigateur et de l’application :
  • applicationName - Nom de votre site de documentation
  • generator: Mintlify - Identifie Mintlify comme générateur du site
  • apple-mobile-web-app-title - Nom de l’application sur l’écran d’accueil iOS
  • msapplication-TileColor - Couleur de la tuile Windows
  • Favicons et icônes à partir de votre configuration
  • Lien vers le sitemap
Toutes les balises meta dans votre configuration docs.json seo.metatags sont également automatiquement injectées dans chaque page, par exemple google-site-verification pour la validation dans Google Search Console.

​
Balises méta globales

Pour définir des balises méta par défaut pour toutes les pages, ajoutez le champ metatags dans votre docs.json. 
"seo": {
    "metatags": {
        "og:image": "lien vers votre image de balise méta par défaut"
    }
}

​
Définir une URL canonique

Si vous utilisez un domaine personnalisé, définissez la balise meta canonical pour vous assurer que les moteurs de recherche indexent votre domaine préféré. Une URL canonique indique aux moteurs de recherche quelle version de votre documentation fait autorité. Cela améliore le SEO lorsque votre documentation est accessible à partir de plusieurs URL et évite les problèmes de contenu dupliqué. 
"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}

​
Balises méta spécifiques à une page

Pour définir des balises méta spécifiques à une page, ajoutez-les dans le frontmatter de la page. Les balises méta suivantes sont prises en charge au niveau de la page :
  • title - Titre de la page
  • description - La description de la page apparaît sous le titre sur la page et dans certains résultats des moteurs de recherche
  • keywords - Mots-clés séparés par des virgules
  • og:title - Titre Open Graph pour le partage sur les réseaux sociaux
  • og:description - Description Open Graph
  • og:image - URL de l’image Open Graph
  • og:url - URL Open Graph
  • og:type - Type Open Graph comme “article” ou “website”
  • og:image:width - Largeur de l’image Open Graph
  • og:image:height - Hauteur de l’image Open Graph
  • twitter:title - Titre de la carte Twitter
  • twitter:description - Description de la carte Twitter
  • twitter:image - Image de la carte Twitter
  • twitter:card - Type de carte Twitter comme “summary” ou “summary_large_image”
  • twitter:site - Handle du compte Twitter du site
  • twitter:image:width - Largeur de l’image Twitter
  • twitter:image:height - Hauteur de l’image Twitter
  • noindex - À définir sur true pour empêcher l’indexation par les moteurs de recherche
  • robots - Valeur de la balise méta robots
---
title: "Titre de votre page d'exemple"
description: "Description spécifique de la page"
"og:image": "lien vers votre image de balise meta"
"og:title": "Titre pour les réseaux sociaux"
keywords: ["mot-clé1", "mot-clé2"]
---
Les balises méta comportant des deux-points doivent être encadrées de guillemets. Le champ keywords doit être formaté comme un tableau YAML.

​
Référence des balises meta courantes

Vous trouverez ci-dessous une liste complète des balises meta que vous pouvez ajouter à votre docs.json. Ces balises meta améliorent le SEO de votre site, le partage sur les réseaux sociaux et la compatibilité avec les navigateurs.
La balise og:image ajoute une image d’arrière-plan que Mintlify superpose automatiquement avec votre logo, le titre de la page et la description lors de la génération des aperçus pour les réseaux sociaux.
Vous pouvez prévisualiser l’apparence de vos balises meta sur différentes plateformes à l’aide de metatags.io. 
"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "Description de la page",
      "keywords": "mot-clé1, mot-clé2, mot-clé3",
      "author": "Nom de l'auteur",
      "robots": "index, follow",
      "googlebot": "index, follow",
      "google": "notranslate",
      "google-site-verification": "verification_token",
      "generator": "Mintlify",
      "theme-color": "#000000",
      "color-scheme": "light dark",
      "canonical": "https://your-custom-domain-here.com",
      "format-detection": "telephone=no",
      "referrer": "origin",
      "refresh": "30",
      "rating": "general",
      "revisit-after": "7 days",
      "language": "en",
      "copyright": "Copyright 2024",
      "reply-to": "[email protected]",
      "distribution": "global",
      "coverage": "Mondial",
      "category": "Technologie",
      "target": "all",
      "HandheldFriendly": "True",
      "MobileOptimized": "320",
      "apple-mobile-web-app-capable": "yes",
      "apple-mobile-web-app-status-bar-style": "black",
      "apple-mobile-web-app-title": "Titre de l'application",
      "application-name": "Nom de l'application",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Titre Open Graph",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Description Open Graph",
      "og:site_name": "Nom du site",
      "og:locale": "en_US",
      "og:video": "https://example.com/video.mp4",
      "og:audio": "https://example.com/audio.mp3",
      "twitter:card": "summary",
      "twitter:site": "@username",
      "twitter:creator": "@username",
      "twitter:title": "Titre Twitter",
      "twitter:description": "Description Twitter",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "Description de l'image",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "Nom de l'application",
      "twitter:app:id:iphone": "12345",
      "twitter:app:url:iphone": "app://",
      "article:published_time": "2024-01-01T00:00:00+00:00",
      "article:modified_time": "2024-01-02T00:00:00+00:00",
      "article:expiration_time": "2024-12-31T00:00:00+00:00",
      "article:author": "Nom de l'auteur",
      "article:section": "Technologie",
      "article:tag": "tag1, tag2, tag3",
      "book:author": "Nom de l'auteur",
      "book:isbn": "1234567890",
      "book:release_date": "2024-01-01",
      "book:tag": "tag1, tag2, tag3",
      "profile:first_name": "John",
      "profile:last_name": "Doe",
      "profile:username": "johndoe",
      "profile:gender": "male",
      "music:duration": "205",
      "music:album": "Nom de l'album",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "Nom de l'artiste",
      "music:song": "Nom de la chanson",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "Nom de l'acteur",
      "video:actor:role": "Nom du rôle",
      "video:director": "Nom du réalisateur",
      "video:writer": "Nom du scénariste",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "tag1, tag2, tag3",
      "video:series": "Nom de la série"
  }
}

​
Sitemaps et fichiers robots.txt

Mintlify génère automatiquement un fichier sitemap.xml et un fichier robots.txt. Vous pouvez consulter votre sitemap en ajoutant /sitemap.xml à l’URL de votre site de documentation. Par défaut, seules les pages présentes dans votre docs.json sont incluses. Pour inclure des liens masqués, ajoutez seo.indexing à votre docs.json : 
"seo": {
    "indexing": "all"
}

​
Plans de site personnalisés et fichiers robots.txt

Pour ajouter un sitemap.xml ou un robots.txt personnalisé, créez un fichier sitemap.xml ou robots.txt à la racine de votre projet. L’ajout d’un fichier personnalisé remplacera le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, le fichier par défaut sera à nouveau utilisé.

​
Désactivation de l’indexation

Si vous souhaitez empêcher l’indexation d’une page par les moteurs de recherche, vous pouvez inclure ce qui suit dans le frontmatter de votre page : 
---
noindex: true
---
Vous pouvez également définir noindex pour toutes les pages de votre documentation en réglant le champ metatags.robots sur "noindex" dans votre docs.json : 
"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

​
Bonnes pratiques SEO

  • Utilisez des titres de page clairs et informatifs (50–60 caractères)
  • Rédigez des descriptions attrayantes (150–160 caractères)
  • Intégrez des mots-clés pertinents
  • Rendez chaque titre de page et chaque description uniques
  • Respectez une hiérarchie de titres appropriée (H1 → H2 → H3)
  • Écrivez d’abord pour les utilisateurs, ensuite pour les moteurs de recherche
  • Intégrez des mots-clés pertinents dans les titres et le contenu
  • Gardez les URL courtes, descriptives et organisées de façon hiérarchique
  • Scindez les contenus longs avec des sous-titres et des listes
  • Faites des liens vers des pages connexes au sein de votre documentation
  • Utilisez un texte d’ancre descriptif plutôt que « cliquez ici »
  • Créez des clusters thématiques en reliant des concepts associés
  • Utilisez les fonctionnalités d’auto-référencement
  • Utilisez des noms de fichiers descriptifs pour les images
  • Incluez toujours un texte alternatif pour l’accessibilité et le SEO
  • Optimisez la taille des fichiers image pour un chargement plus rapide
  • Utilisez des images pertinentes qui étayent votre contenu