From 422d88ed53c86270355242c4f4d5560d23a39761 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Fri, 10 Jan 2025 13:50:03 +0100 Subject: [PATCH] translate reference/route-data.md & update translation of reference/overrides.md --- .../content/docs/de/reference/overrides.md | 143 +--------------- .../content/docs/de/reference/route-data.md | 153 ++++++++++++++++++ 2 files changed, 154 insertions(+), 142 deletions(-) create mode 100644 docs/src/content/docs/de/reference/route-data.md diff --git a/docs/src/content/docs/de/reference/overrides.md b/docs/src/content/docs/de/reference/overrides.md index 0e14fff553a..305cb2836c6 100644 --- a/docs/src/content/docs/de/reference/overrides.md +++ b/docs/src/content/docs/de/reference/overrides.md @@ -12,147 +12,6 @@ Diese Seite listet alle Komponenten auf, die überschrieben werden können, und Erfahre mehr in der [Anleitung zum Überschreiben von Komponenten](/de/guides/overriding-components/). -## Komponenteneigenschaften (Props) - -Alle Komponenten können auf ein Standardobjekt `Astro.props` zugreifen, welches Informationen über die aktuelle Seite enthält. - -Um deine eigenen Komponenten zu schreiben, importiere den `Props`-Typ von Starlight: - -```astro ---- -// src/components/Custom.astro -import type { Props } from '@astrojs/starlight/props'; - -const { hasSidebar } = Astro.props; -// ^ Typ: boolean ---- -``` - -So erhaltest du die Autovervollständigung und Angabe des Datentyps beim Zugriff auf `Astro.props`. - -### Eigenschaften - -Starlight wird die folgenden Props an deine eigenen Komponenten übergeben. - -#### `dir` - -**Typ:** `'ltr' | 'rtl'` - -Schreibrichtung der Seite. - -#### `lang` - -**Typ:** `string` - -BCP-47-Sprachkennzeichen für das Gebietsschema dieser Seite, z.B. `de`, `zh-CN` oder `pt-BR`. - -#### `locale` - -**Typ:** `string | undefined` - -Der Basispfad, unter dem eine Sprache angeboten wird. `undefined` für Root-Locale-Slugs. - -#### `siteTitle` - -**Typ:** `string` - -Der Seitentitel für das Gebietsschema dieser Seite. - -#### `siteTitleHref` - -**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/`. - -#### `slug` - -**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`](/de/manual-setup/#konfigurieren-von-inhaltssammlungen) benutzt und verwende stattdessen die Eigenschaft [`id`](#id). - -#### `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`](https://docs.astro.build/de/reference/legacy-flags/#collections) benutzt. - -#### `isFallback` - -**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. - -#### `entryMeta` - -**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. - -#### `entry` - -Der Astro-Inhaltssammlungseintrag für die aktuelle Seite. -Beinhaltet Frontmatter-Werte für die aktuelle Seite in `entry.data`. - -```ts -entry: { - data: { - title: string; - description: string | undefined; - // usw. - } -} -``` - -Erfahre mehr über die Form dieses Objekts in der [Astros Eintragstyp-Sammlung](https://docs.astro.build/de/reference/modules/astro-content/#collectionentry) Referenz. - -#### `sidebar` - -**Typ:** `SidebarEntry[]` - -Seitennavigationseinträge für diese Seite. - -#### `hasSidebar` - -**Typ:** `boolean` - -Ob die Seitenleiste auf dieser Seite angezeigt werden soll oder nicht. - -#### `pagination` - -**Typ:** `{ prev?: Link; next?: Link }` - -Links zur vorherigen und nächsten Seite in der Seitenleiste, falls aktiviert. - -#### `toc` - -**Typ:** `{ minHeadingLevel: number; maxHeadingLevel: number; items: TocItem[] } | undefined` - -Inhaltsverzeichnis für diese Seite, falls aktiviert. - -#### `headings` - -**Typ:** `{ depth: number; slug: string; text: string }[]` - -Array aller Markdown-Überschriften, die aus der aktuellen Seite extrahiert wurden. -Verwende stattdessen [`toc`](#toc), wenn du einen Inhaltsverzeichnis-Komponenten erstellen willst, welches die Konfigurationsoptionen von Starlight berücksichtigt. - -#### `lastUpdated` - -**Typ:** `Date | undefined` - -JavaScript `Date` Objekt, welches angibt, wann diese Seite zuletzt aktualisiert wurde, falls aktiviert. - -#### `editUrl` - -**Typ:** `URL | undefined` - -`URL`-Objekt für die Adresse, unter der diese Seite bearbeitet werden kann, falls aktiviert. - --- ## Komponenten @@ -232,7 +91,7 @@ Diese Komponenten stellen die obere Navigationsleiste von Starlight dar. **Standardkomponente:** [`Header.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Header.astro) Dies ist eine Kopfzielen-Komponente, welche oben auf jeder Seite angezeigt wird. -Die Standardimplementierung zeigt [``](#sitetitle-1), [``](#search), [``](#socialicons), [``](#themeselect), und [``](#languageselect). +Die Standardimplementierung zeigt [``](#sitetitle), [``](#search), [``](#socialicons), [``](#themeselect), und [``](#languageselect). #### `SiteTitle` diff --git a/docs/src/content/docs/de/reference/route-data.md b/docs/src/content/docs/de/reference/route-data.md new file mode 100644 index 00000000000..752994f6ac0 --- /dev/null +++ b/docs/src/content/docs/de/reference/route-data.md @@ -0,0 +1,153 @@ +--- +title: Routendaten Referenz +description: Die vollständige Referenzdokumentation für Starlights Routendatenobjekt. +sidebar: + label: Routendaten +--- + +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](/de/guides/route-data/). + +In Astro-Komponenten greifst du auf die Routendaten von `Astro.locals.starlightRoute` zu: + +```astro {4} +--- +// src/components/Individuell.astro + +const { hasSidebar } = Astro.locals.starlightRoute; +--- +``` + +In der [Routen-Middleware](/de/guides/route-data/#anpassen-der-routendaten) greifst du auf die Routendaten aus dem Kontextobjekt zu, das an deine Middleware-Funktion übergeben wird: + +```ts {5} +// src/routeData.ts +import { defineRouteMiddleware } from '@astrojs/starlight/route-data'; + +export const onRequest = defineRouteMiddleware((context) => { + const { hasSidebar } = context.locals.starlightRoute; +}); +``` + +## `starlightRoute` + +Das Objekt `starlightRoute` hat die folgenden Eigenschaften: + +### `dir` + +**Typ:** `'ltr' | 'rtl'` + +Schreibrichtung der Seite. + +### `lang` + +**Typ:** `string` + +BCP-47-Sprachkennzeichen für das Gebietsschema dieser Seite, z.B. `de`, `zh-CN` oder `pt-BR`. + +### `locale` + +**Typ:** `string | undefined` + +Der Basispfad, unter dem eine Sprache angeboten wird. `undefined` für Root-Locale-Slugs. + +### `siteTitle` + +**Typ:** `string` + +Der Seitentitel für das Gebietsschema dieser Seite. + +### `siteTitleHref` + +**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/`. + +### `slug` + +**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`](/de/manual-setup/#konfigurieren-von-inhaltssammlungen) benutzt und verwende stattdessen die Eigenschaft [`id`](#id). + +### `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`](https://docs.astro.build/de/reference/legacy-flags/#collections) benutzt. + +### `isFallback` + +**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. + +### `entryMeta` + +**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. + +### `entry` + +Der Astro-Inhaltssammlungseintrag für die aktuelle Seite. +Beinhaltet Frontmatter-Werte für die aktuelle Seite in `entry.data`. + +```ts +entry: { + data: { + title: string; + description: string | undefined; + // usw. + } +} +``` + +Erfahre mehr über die Form dieses Objekts in der [Astros Eintragstyp-Sammlung](https://docs.astro.build/de/reference/modules/astro-content/#collectionentry) Referenz. + +### `sidebar` + +**Typ:** `SidebarEntry[]` + +Seitennavigationseinträge für diese Seite. + +### `hasSidebar` + +**Typ:** `boolean` + +Ob die Seitenleiste auf dieser Seite angezeigt werden soll oder nicht. + +### `pagination` + +**Typ:** `{ prev?: Link; next?: Link }` + +Links zur vorherigen und nächsten Seite in der Seitenleiste, falls aktiviert. + +### `toc` + +**Typ:** `{ minHeadingLevel: number; maxHeadingLevel: number; items: TocItem[] } | undefined` + +Inhaltsverzeichnis für diese Seite, falls aktiviert. + +### `headings` + +**Typ:** `{ depth: number; slug: string; text: string }[]` + +Array aller Markdown-Überschriften, die aus der aktuellen Seite extrahiert wurden. +Verwende stattdessen [`toc`](#toc), wenn du einen Inhaltsverzeichnis-Komponenten erstellen willst, welches die Konfigurationsoptionen von Starlight berücksichtigt. + +### `lastUpdated` + +**Typ:** `Date | undefined` + +JavaScript `Date` Objekt, welches angibt, wann diese Seite zuletzt aktualisiert wurde, falls aktiviert. + +### `editUrl` + +**Typ:** `URL | undefined` + +`URL`-Objekt für die Adresse, unter der diese Seite bearbeitet werden kann, falls aktiviert.