SEO-Optimierung

Optimieren Sie Ihre Dokumentation für Suchmaschinen und Social Previews, indem Sie Titel, Beschreibungen und Metadaten im Frontmatter festlegen.

Was Jamdesk automatisch erledigt

Inhalte optimieren

Effektives Frontmatter verfassen

---
title: User Authentication    # Under 60 characters
description: Set up OAuth, JWT, and session-based authentication  # 120-160 characters
---

Seitentitel

• Halten Sie Titel unter 60 Zeichen, um eine Kürzung in den Suchergebnissen zu vermeiden
• Fügen Sie Ihr primäres Keyword möglichst weit vorne ein
• Verwenden Sie in Ihrer Dokumentation für jeden Titel eine eindeutige Formulierung

Beschreibungen

• Streben Sie 120–160 Zeichen an
• Fassen Sie zusammen, was die lesende Person erfahren wird
• Fügen Sie relevante Keywords auf natürliche Weise ein

Indexierung steuern

Websiteweite Einstellungen

Konfigurieren Sie in Ihrer docs.json das standardmäßige Verhalten für Robots:

{
  "seo": {
    "metatags": {
      "robots": "index, follow"
    }
  }
}

Steuerung pro Seite

Überschreiben Sie die Indexierung für bestimmte Seiten im Frontmatter:

---
title: Internal Notes
noindex: true
---

Verwenden Sie noindex für:

• Entwürfe oder Seiten in Bearbeitung
• Interne Dokumentation
• Veraltete Inhalte, die Sie als Referenz behalten

Suchindexierung vs. AI-Aufnahme

robots-Metadaten und noindex steuern Suchmaschinen: ob eine Seite in Google und Ihrer sitemap.xml erscheint. Sie haben keine Auswirkungen auf die Dateien llms.txt und llms-full.txt, die AI-Tools lesen. Um deren Veröffentlichung zu verhindern, setzen Sie seo.ai.llmsTxt auf false (siehe llms.txt deaktivieren). Die beiden Einstellungen sind unabhängig: Eine Seite kann von Suchmaschinen indexiert, aber von der AI-Aufnahme ausgeschlossen werden – oder umgekehrt.

Kanonische URLs

Wenn Ihre Dokumentation unter mehreren URLs erreichbar ist, legen Sie eine kanonische URL fest:

---
title: Getting Started
canonical: https://docs.example.com/getting-started
---

Sie können auch eine websiteweite kanonische Basis-URL in docs.json festlegen. Jamdesk hängt den Pfad jeder Seite daran an, sodass jede Seite eine korrekte seitenbezogene kanonische URL erhält:

{
  "seo": {
    "metatags": {
      "canonical": "https://docs.acme.com"
    }
  }
}

Social Previews & Open Graph

Jamdesk erstellt automatisch eine gebrandete Social Card mit 1200×630 Pixeln für jede Seite. Überschreiben Sie beliebige Social-Tags im Frontmatter. Sie können flache Schlüssel auf oberster Ebene oder einen verschachtelten seo:-Block verwenden. Beides funktioniert. Wenn derselbe Schlüssel auf beide Arten festgelegt ist, hat der Wert auf oberster Ebene Vorrang.

---
title: API Reference
description: REST API endpoints and authentication
"og:title": API Reference — Acme
"og:description": Everything you need to call the Acme API
"og:image": /images/api-social-card.png
"twitter:card": summary_large_image
"twitter:creator": "@acme"
keywords: ["api", "rest", "authentication"]
canonical: https://docs.acme.com/api-reference
---

---
title: API Reference
description: REST API endpoints and authentication
seo:
  "og:title": API Reference — Acme
  "og:image": /images/api-social-card.png
  "twitter:card": summary_large_image
  x-custom-tag: any custom meta value
---

Unterstützte Tags

Card-Typ für Twitter / X

Der Tag twitter:card steuert, welches Layout X (und andere Plattformen) verwendet, wenn Ihr Link geteilt wird:

Verwenden Sie für eine gebrandete Card mit 1200×630 Pixeln summary_large_image, damit das Bild in voller Breite dargestellt wird.

Websiteweites Standardbild

Legen Sie ein Fallback-Social-Bild für jede Seite in docs.json fest. Jede Seite, die ein eigenes og:image festlegt, überschreibt dieses:

{
  "seo": {
    "metatags": {
      "og:image": "https://docs.acme.com/images/default-card.png"
    }
  }
}

Sitemap & Robots.txt

Jede Jamdesk-Website erstellt bei jedem Build automatisch sitemap.xml und robots.txt.

Wo Sie sie finden

Die URLs hängen davon ab, ob Ihre Dokumentation unter einer Root-Domain oder unter einem /docs-Unterpfad liegt:

https://docs.acme.com/sitemap.xml
https://docs.acme.com/robots.txt

Was in der Sitemap enthalten ist

• Alle veröffentlichten Seiten (ausgenommen Seiten mit noindex oder hidden im Frontmatter)
• Änderungsdaten aus dem Frontmatter, sofern verfügbar
• Wöchentliche Änderungshäufigkeit

Seiten aus der Sitemap ausschließen

Fügen Sie noindex zum Frontmatter hinzu, um eine Seite sowohl aus der Sitemap als auch aus den Suchmaschinen auszuschließen:

---
title: Internal Notes
noindex: true
---

Seiten mit hidden: true werden ebenfalls automatisch ausgeschlossen.

Strukturierte Daten mit JSON-LD

Jede Seite enthält automatisch strukturierte schema.org-Daten als <script type="application/ld+json">-Tag mit zwei Schemata:

• WebSite: Name, URL und Beschreibung Ihrer Website (aus docs.json).
• BreadcrumbList: Navigationspfad von Home zur aktuellen Seite, abgeleitet aus Ihrer navigation-Konfiguration.

Keine Konfiguration erforderlich. Suchmaschinen verwenden diese Daten für umfangreiche Ergebnisse wie Breadcrumb-Pfade in Suchergebnissen.

IndexNow

Nach jedem Build übermittelt Jamdesk automatisch geänderte Seiten-URLs an IndexNow, damit Suchmaschinen sie schneller indexieren. Dadurch werden Bing, Yandex und andere teilnehmende Suchmaschinen über Ihre Inhaltsänderungen informiert, ohne auf den nächsten Crawl-Zyklus warten zu müssen.

• Wird nach jedem erfolgreichen Build ausgeführt
• Übermittelt nur Seiten, die tatsächlich geändert wurden
• Nicht blockierend, sodass der Build nie verzögert wird
• Keine Konfiguration erforderlich

Best Practices

Gehen Sie diese Checkliste vor der Veröffentlichung durch:

Verwandte Artikel