SEO

Tiramisu Docs enthält eingebaute SEO-Funktionen, die Ihrer Dokumentation helfen, in Suchmaschinen gut zu ranken.

Sitemap

Eine Sitemap wird automatisch unter /sitemap.xml generiert. Sie enthält alle Dokumentationsseiten mit ihrem letzten Bearbeitungsdatum.

Um die Sitemap zu aktivieren, setzen Sie das Feld url in Ihrer Konfiguration:

export default defineConfig({
  url: "https://docs.example.com",
  // ...
});

Die url ist erforderlich, um absolute URLs in der Sitemap zu generieren.

Meta-Tags

Jede Dokumentationsseite erhält automatisch Meta-Tags, die aus ihrem meta {}-Block abgeleitet werden:

Open Graph

• og:title — vom Seitentitel
• og:description — von der Seitenbeschreibung
• og:type — immer article
• og:url — kanonische URL, zusammengesetzt aus Ihrer Website-url und dem Seiten-Slug
• og:site_name — vom title in Ihrer Konfiguration
• og:image — vom Feld image in den Seiten-Metadaten

Twitter Cards

• twitter:card — summary_large_image wenn ein Bild gesetzt ist, sonst summary
• twitter:title — vom Seitentitel
• twitter:description — von der Seitenbeschreibung
• twitter:image — vom Feld image in den Seiten-Metadaten

OG-Bild

Sie können ein Open-Graph-Bild pro Seite über das Feld image im meta {}-Block der Seite setzen:

meta {
  title = Getting Started,
  description = Learn how to get started,
  image = /images/getting-started.png
}

Der Bildpfad kann relativ zu Ihrem Website-Stammverzeichnis sein (z.B. /images/hero.png) oder eine absolute URL (z.B. https://example.com/og.png). Relative Pfade werden gegen Ihre Website-url aufgelöst.

Kanonische URL

Ein <link rel=canonical>-Tag wird jeder Seite hinzugefügt, wenn eine Website-url konfiguriert ist. Dies hilft Suchmaschinen, die bevorzugte URL für jede Seite zu identifizieren.

JSON-LD Strukturierte Daten

Jede Seite enthält ein TechArticle-JSON-LD-Schema mit:

• headline — der Seitentitel
• url — die kanonische Seiten-URL
• mainEntityOfPage — eine WebPage-Referenz
• isPartOf — eine WebSite-Referenz mit Ihrem Websitenamen und URL
• description — falls eine Beschreibung in den Seiten-Metadaten gesetzt ist
• dateModified — falls die Nachverfolgung der letzten Bearbeitung aktiviert ist
• image — falls ein Bild in den Seiten-Metadaten gesetzt ist
• author — falls ein Autor in den Seiten-Metadaten gesetzt ist (als Person-Entität)

All diese Tags werden automatisch generiert. Sie müssen nur url und title in Ihrer Konfiguration setzen und title sowie description zum meta {}-Block jeder Seite hinzufügen.

Sitemap anpassen

Die Sitemap-Route wird beim Erstellen eines Projekts automatisch eingebunden. Wenn Sie sie anpassen müssen, befindet sich die generierte Route unter src/routes/sitemap.xml/+server.ts und verwendet die Funktion generateSitemap() aus dem Kit.