Mintlify übernimmt automatisch viele SEO-Best Practices, darunter:
  • Generierung von Meta-Tags
  • Generierung von Sitemap und robots.txt-Datei
  • Semantische HTML-Struktur
  • Mobile Optimierung
Sie können die Meta-Tags Ihrer Website vollständig anpassen, indem Sie das Feld metatags zu Ihrer docs.json oder zum Frontmatter einer Seite hinzufügen.

​
Globale Metatags

Sie können Standard-Metatags festlegen, indem Sie das Feld metadata zu Ihrer docs.json hinzufügen. 
"seo": {
    "metatags": {
        "og:image": "Link zu Ihrem standardmäßigen Metatag-Bild"
    }
}

​
Seitenspezifische Meta-Tags

Füge die Meta-Tags wie folgt in die Metadaten der Seite ein: 
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---
Meta-Tags mit Doppelpunkten müssen in Anführungszeichen stehen, wenn du sie in die Seitenmetadaten einfügst.

​
Referenz für gängige Meta-Tags

Nachfolgend finden Sie eine umfassende Liste von Meta-Tags, die Sie Ihrer docs.json hinzufügen können. Diese Meta-Tags verbessern die SEO Ihrer Website, das Teilen in sozialen Netzwerken und die Browserkompatibilität. Mit metatags.io können Sie eine Vorschau anzeigen, wie Ihre Meta-Tags auf verschiedenen Plattformen dargestellt werden. 
"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "Seitenbeschreibung",
      "keywords": "Keywords: keyword1, keyword2, keyword3",
      "author": "Autorname",
      "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": "Technology",
      "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": "App-Titel",
      "application-name": "App-Name",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Open-Graph-Titel",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Open-Graph-Beschreibung",
      "og:site_name": "Seitenname",
      "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": "Twitter-Titel",
      "twitter:description": "Twitter-Beschreibung",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "Bildbeschreibung",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "App-Name",
      "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": "Autorname",
      "article:section": "Technologie",
      "article:tag": "tag1, tag2, tag3",
      "book:author": "Autorname",
      "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": "Albumname",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "Künstlername",
      "music:song": "Songtitel",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "Schauspielername",
      "video:actor:role": "Rollenname",
      "video:director": "Regisseur",
      "video:writer": "Drehbuchautor",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "tag1, tag2, tag3",
      "video:series": "Serienname"
  }
}

​
Sitemaps und robots.txt-Dateien

Mintlify generiert automatisch eine sitemap.xml-Datei und eine robots.txt-Datei. Sie können Ihre Sitemap anzeigen, indem Sie /sitemap.xml an die URL Ihrer Dokumentationsseite anhängen. Standardmäßig werden nur Seiten aufgenommen, die in Ihrer docs.json enthalten sind. Um verborgene Links einzuschließen, fügen Sie seo.indexing zu Ihrer docs.json hinzu: 
"seo": {
    "indexing": all
}

​
Benutzerdefinierte Sitemaps und robots.txt-Dateien

Um eine benutzerdefinierte sitemap.xml oder robots.txt hinzuzufügen, erstellen Sie eine Datei sitemap.xml oder robots.txt im Stammverzeichnis Ihres Projekts. Eine benutzerdefinierte Datei ersetzt die automatisch generierte Datei mit demselben Namen. Wenn Sie die benutzerdefinierte Datei löschen, wird wieder die Standarddatei verwendet.

​
Deaktivieren der Indexierung

Wenn Sie verhindern möchten, dass eine Seite von Suchmaschinen indexiert wird, können Sie Folgendes in das Frontmatter Ihrer Seite aufnehmen: 
---
noindex: true
---
Sie können noindex auch für alle Seiten in Ihren Docs festlegen, indem Sie das Feld metadata.robots in Ihrer docs.json auf "noindex" setzen: 
"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

​
SEO-Best Practices