| title | description | sidebar | ||
|---|---|---|---|---|
Routendaten Referenz |
Die vollständige Referenzdokumentation für Starlights Routendatenobjekt. |
|
Das Routendatenobjekt von Starlight enthält Informationen über die aktuelle Seite. Erfahre mehr darüber, wie das Datenmodell von Starlight funktioniert, in der „Routendaten“-Anleitung.
In Astro-Komponenten greifst du auf die Routendaten von Astro.locals.starlightRoute zu:
---
// src/components/Individuell.astro
const { hasSidebar } = Astro.locals.starlightRoute;
---In der Routen-Middleware greifst du auf die Routendaten aus dem Kontextobjekt zu, das an deine Middleware-Funktion übergeben wird:
// src/routeData.ts
import { defineRouteMiddleware } from '@astrojs/starlight/route-data';
export const onRequest = defineRouteMiddleware((context) => {
const { hasSidebar } = context.locals.starlightRoute;
});Das Objekt starlightRoute hat die folgenden Eigenschaften:
Typ: 'ltr' | 'rtl'
Schreibrichtung der Seite.
Typ: string
BCP-47-Sprachkennzeichen für das Gebietsschema dieser Seite, z.B. de, zh-CN oder pt-BR.
Typ: string | undefined
Der Basispfad, unter dem eine Sprache angeboten wird. undefined für Root-Locale-Slugs.
Typ: string
Der Seitentitel für das Gebietsschema dieser Seite.
Typ: string
Der Wert für das Attribut href des Seitentitels, der auf die Homepage zurückverweist, z. B. /.
Bei mehrsprachigen Websites wird hier das aktuelle Gebietsschema angegeben, z. B. /en/ oder /zh-cn/.
Typ: string
Der aus dem Dateinamen des Inhalts generierte Slug für diese Seite.
Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version von Starlight entfernt werden.
Stelle auf die neue Content Layer API um, indem du Starlights docsLoader benutzt und verwende stattdessen die Eigenschaft id.
Typ: string
Der Slug für diese Seite oder die eindeutige ID für diese Seite, die auf dem Dateinamen des Inhalts basiert, wenn du das Flag legacy.collections benutzt.
Typ: true | undefined
true, wenn diese Seite in der aktuellen Sprache unübersetzt ist und Fallback-Inhalte aus dem Standardgebietsschema verwendet.
Wird nur in mehrsprachigen Sites verwendet.
Typ: { dir: 'ltr' | 'rtl'; lang: string }
Gebietsschema-Metadaten für den Seiteninhalt. Du kannst von den Werten der Top-Level-Locale unterscheiden, wenn eine Seite Fallback-Inhalte verwendet.
Der Astro-Inhaltssammlungseintrag für die aktuelle Seite.
Beinhaltet Frontmatter-Werte für die aktuelle Seite in entry.data.
entry: {
data: {
title: string;
description: string | undefined;
// usw.
}
}Erfahre mehr über die Form dieses Objekts in der Astros Eintragstyp-Sammlung Referenz.
Typ: SidebarEntry[]
Seitennavigationseinträge für diese Seite.
Typ: boolean
Ob die Seitenleiste auf dieser Seite angezeigt werden soll oder nicht.
Typ: { prev?: Link; next?: Link }
Links zur vorherigen und nächsten Seite in der Seitenleiste, falls aktiviert.
Typ: { minHeadingLevel: number; maxHeadingLevel: number; items: TocItem[] } | undefined
Inhaltsverzeichnis für diese Seite, falls aktiviert.
Typ: { depth: number; slug: string; text: string }[]
Array aller Markdown-Überschriften, die aus der aktuellen Seite extrahiert wurden.
Verwende stattdessen toc, wenn du einen Inhaltsverzeichnis-Komponenten erstellen willst, welches die Konfigurationsoptionen von Starlight berücksichtigt.
Typ: Date | undefined
JavaScript Date Objekt, welches angibt, wann diese Seite zuletzt aktualisiert wurde, falls aktiviert.
Typ: URL | undefined
URL-Objekt für die Adresse, unter der diese Seite bearbeitet werden kann, falls aktiviert.