Mintlify prend automatiquement en charge 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 à votre docs.json ou au front matter d’une page.

​
Balises méta globales

Vous pouvez définir des balises méta par défaut en ajoutant le champ metadata à votre docs.json. 
"seo": {
  "metatags": {
    "og:image": "lien vers l’image méta par défaut"
  }
}

​
Balises méta propres à une page

Ajoutez vos balises méta aux métadonnées de la page comme suit : 
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---
Les balises méta contenant des deux-points doivent être entourées de guillemets lorsque vous les ajoutez aux métadonnées de la page.

​
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 contribuent à améliorer le référencement (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": "fr",
      "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": "fr_FR",
      "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 caché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 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 de nouveau utilisé.

​
Désactiver l’indexation

Si vous souhaitez empêcher une page d’être indexée par les moteurs de recherche, ajoutez l’élément suivant dans le frontmatter de votre page : 
---
noindex: true
---
Vous pouvez aussi appliquer noindex à toutes les pages de votre documentation en définissant le champ metadata.robots sur "noindex" dans votre docs.json : 
"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

​
Bonnes pratiques SEO