SEO-Optimierung

Legen Sie Titel, Beschreibungen und Metadaten im Frontmatter fest, um zu steuern, wie Ihre Dokumentation in Suchmaschinen und Social-Media-Vorschauen erscheint.

Was Jamdesk automatisch erledigt

Inhalte optimieren

Aussagekräftiges 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, einschließlich des Site-Namens, den Ihr Titelformat hinzufügt. Längere Titel werden in den Suchergebnissen abgeschnitten
• Platzieren Sie Ihr wichtigstes Keyword möglichst am Anfang
• Machen Sie jeden Titel in Ihrer Dokumentation eindeutig

Standardmäßig lautet der Titel im Browser-Tab und in den Suchergebnissen Seitentitel — Site-Name. Ändern Sie ihn mit seo.titleTemplate in docs.json. Setzen Sie %s an die Stelle, an der der Seitentitel stehen soll:

{
  "seo": {
    "titleTemplate": "%s | Acme"
  }
}

Eine Seite mit dem Titel Getting started zeigt dann Getting started | Acme. Verwenden Sie "%s" allein, um den Site-Namen wegzulassen. Eine Vorlage ohne %s lässt den Build fehlschlagen. jamdesk validate zeigt den Fehler an. Link-Vorschauen (og:title und twitter:title) zeigen weiterhin nur den Seitentitel.

Manche Seiten verwenden die Vorlage nicht. Eine Seite ohne title zeigt Ihren name gefolgt von „Documentation“, etwa Acme Documentation, oder nur Ihren name, wenn dieser bereits auf „Docs“ oder „Documentation“ endet. Eine Seite, deren Titel mit Ihrem name identisch ist, zeigt nur diesen Titel.

jamdesk validate und jamdesk dev akzeptieren seo.titleTemplate ab CLI-Version 1.1.220. Aktualisieren Sie mit npm i -g jamdesk@latest.

Beschreibungen

• Zielen Sie auf 120–160 Zeichen
• Fassen Sie zusammen, was die Leserin oder der Leser lernen wird
• Integrieren Sie relevante Keywords natürlich

Indexierung steuern

Einstellungen für die gesamte Website

Legen Sie das Standardverhalten der Robots in docs.json fest:

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

Einstellungen für einzelne Seiten

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

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

Verwenden Sie noindex für:

• Entwurfs- oder Arbeitsstand-Seiten
• Interne Dokumentation
• Veraltete Inhalte, die Sie als Referenz behalten

Suchmaschinenindexierung und KI-Verarbeitung

robots-Metadaten und noindex steuern Suchmaschinen: ob eine Seite in Google und in Ihrer sitemap.xml erscheint. Sie haben keinen Einfluss auf die Dateien llms.txt und llms-full.txt, die KI-Tools lesen. Setzen Sie seo.ai.llmsTxt auf false, um deren Veröffentlichung zu beenden (siehe llms.txt deaktivieren). Die beiden Steuerungen sind unabhängig voneinander: Eine Seite kann von Suchmaschinen indexiert, aber von der KI-Ingestion ausgeschlossen werden, oder umgekehrt.

Kanonische URLs

Setzen Sie eine Canonical-URL, wenn Ihre Dokumentation unter mehreren URLs erreichbar ist:

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

Sie können außerdem eine site-weite Canonical-Basis in docs.json festlegen. Jamdesk hängt den Pfad jeder Seite daran an:

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

Social-Media-Vorschauen und Open Graph

Jamdesk erzeugt für jede Seite eine gebrandete Social-Card mit 1200×630 Pixeln. Überschreiben Sie jedes Social-Tag im Frontmatter mit flachen Schlüsseln auf oberster Ebene oder einem verschachtelten seo:-Block. Der flache Wert auf oberster Ebene gewinnt, wenn derselbe Schlüssel auf beide Arten gesetzt ist.

---
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
---

Unterstützte Tags

Twitter-/X-Kartentyp

Das Tag twitter:card steuert das Layout, das X (und andere Plattformen) beim Teilen Ihres Links verwenden:

Verwenden Sie summary_large_image für eine gebrandete 1200×630-Card. Das Bild wird dann in voller Breite dargestellt.

Standardbild für die gesamte Website

Legen Sie in docs.json ein Ersatzbild für soziale Netzwerke für jede Seite fest. Jede Seite, die ein eigenes og:image setzt, überschreibt es:

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

Social Card anpassen

Ihre generierte Card behält ihr aktuelles Aussehen, sofern Sie nicht seo.socialCard in docs.json ergänzen. Setzen Sie nur die Schlüssel, die Sie ändern möchten:

{
  "seo": {
    "socialCard": {
      "theme": "dark",
      "brandColor": true,
      "accentBar": false,
      "siteName": false,
      "customImage": "replace"
    }
  }
}

Die Card kann nur SVG-, PNG- und JPG-Logos darstellen. Jamdesk wandelt PNG- und JPG-Logodateien in Ihrem Repository beim Build in WebP um. Die Card zeigt dann meist stattdessen Ihr Favicon und behält den Site-Namen bei, selbst mit siteName: false. Verwenden Sie ein SVG-Logo, damit Ihr vollständiges Logo auf der Card erscheint. Verwenden Sie für eine dunkle Card ein SVG als logo.dark.

Die Card kann keinen Text innerhalb eines SVG-Logos darstellen. Dieser Text erscheint leer. Wandeln Sie den Text in Ihrem Designprogramm in Pfade um und exportieren Sie das SVG erneut. In Figma wählen Sie den Text und verwenden Flatten. In Illustrator verwenden Sie Type > Create Outlines. Der Build zeigt einen Hinweis, wenn er Text im SVG-Logo der Card findet. Logos, die als vollständige URL (https://...) festgelegt sind, werden nicht geprüft.

Die Badge-Schrift fällt auf die normale Textfarbe zurück, wenn sich Ihre Markenfarbe nicht genügend vom Hintergrund der Card abhebt. Die Leiste behält Ihre Markenfarbe, sofern sie dem Kartenhintergrund nicht nahezu gleicht. In diesem Fall ist die Leiste grau.

Standardmäßig zeichnet Jamdesk den Seitentitel über Ihr og:image. Setzen Sie "customImage": "replace", um ein Bild mit eigenem Text oder Design unverändert anzuzeigen.

Wählen Sie das theme, das zu einem og:image als Card-Hintergrund passt: dark für ein dunkles Bild, light für ein helles.

Im Modus replace zeichnet Jamdesk keinen Titel auf das Bild. Ein og:image in seo.metatags gilt für jede Seite. Eine Seite, die ein eigenes og:image setzt, verwendet dieses stattdessen. Nur Seiten ohne beides erhalten eine generierte Card. Verwenden Sie ein PNG oder JPG mit 1200×630. Einige Plattformen zeigen keine WebP- oder SVG-Bilder an.

Social-Media-Plattformen speichern Link-Vorschauen zwischen. Ein bereits geteilter Link kann nach Änderungen dieser Einstellungen noch eine Zeit lang die alte Card zeigen. Prüfen Sie die neue Card mit dem Tool OpenGraph-Vorschau.

Sitemap und Robots.txt

Jamdesk erzeugt bei jedem Build sitemap.xml und robots.txt.

Wo du die Dateien findest

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

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

Was die Sitemap enthält

• Alle veröffentlichten Seiten (ohne solche mit noindex- oder hidden-Frontmatter)
• Datum der letzten Änderung aus dem Frontmatter, wenn verfügbar
• Wöchentliche Änderungsfrequenz

Seiten aus der Sitemap ausschließen

Fügen Sie noindex im Frontmatter hinzu, damit eine Seite nicht in der Sitemap und in Suchmaschinen erscheint:

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

Seiten mit hidden: true werden ebenfalls ausgeschlossen.

Strukturierte JSON-LD-Daten

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

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

Es ist keine Konfiguration nötig. Suchmaschinen nutzen dies für Rich Results wie Breadcrumb-Pfade in den Suchergebnissen.

IndexNow

Jamdesk übermittelt nach jedem Build geänderte Seiten-URLs an IndexNow. Bing, Yandex und andere teilnehmende Suchmaschinen erfahren von den Änderungen, ohne auf ihren nächsten Crawl-Zyklus warten zu müssen.

• Wird nach jedem erfolgreichen Build ausgelöst
• Übermittelt nur geänderte Seiten
• Nicht blockierend. Es verzögert Ihren Build nie
• Keine Konfiguration erforderlich

Bewährte Methoden

Gehen Sie vor der Veröffentlichung diese Checkliste durch:

Verwandte Artikel