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

​
Balises méta globales

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

​
Balises méta propres à une page

Pour définir des balises méta propres à une page, ajoutez-les au frontmatter de la page. 
---
title: "Titre de votre page d'exemple"
"og:image": "lien vers votre image de balise meta"
---
Les balises meta contenant des deux-points doivent être entourées de guillemets.

​
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 contribuent à améliorer le SEO de votre site, le partage sur les réseaux sociaux et la compatibilité avec les navigateurs. Vous pouvez prévisualiser l’apparence de vos balises meta sur différentes plateformes avec 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@example.com",
      "distribution": "global",
      "coverage": "Worldwide",
      "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 afficher votre fichier sitemap en ajoutant /sitemap.xml à l’URL de votre site de documentation. Par défaut, seules les pages répertoriées 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 fichier sitemap.xml ou robots.txt personnalisé, créez 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 une page d’être indexée par les moteurs de recherche, vous pouvez inclure ce qui suit dans le frontmatter de votre page : 
---
noindex: true
---
Vous pouvez aussi 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 descriptifs (50-60 caractères)
  • Rédigez des meta descriptions convaincantes (150-160 caractères)
  • Intégrez des mots-clés pertinents
  • Rendez chaque title de page et chaque description uniques
  • Utilisez une hiérarchie de titres appropriée (H1 → H2 → H3)
  • Écrivez d’abord pour les humains, 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 hiérarchiquement
  • Divisez 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 connexes
  • Utilisez les fonctionnalités de renvoi automatique
  • 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 servent votre contenu
⌘I