From 9aaaed88972588d5e6fc92a38d02e436729ab8c9 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:07:08 +0100 Subject: [PATCH 01/13] first steps --- docs/src/content/docs/de/guides/i18n.mdx | 27 ++++++++++--------- .../docs/de/guides/project-structure.mdx | 2 +- .../content/docs/de/guides/site-search.mdx | 4 +-- docs/src/content/docs/de/manual-setup.mdx | 4 +-- .../content/docs/de/reference/frontmatter.md | 8 +++--- 5 files changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/src/content/docs/de/guides/i18n.mdx b/docs/src/content/docs/de/guides/i18n.mdx index 228bf766ed1..f44c86fa551 100644 --- a/docs/src/content/docs/de/guides/i18n.mdx +++ b/docs/src/content/docs/de/guides/i18n.mdx @@ -188,16 +188,16 @@ Du kannst Übersetzungen für zusätzliche Sprachen, die du unterstützt, über -1. Konfiguriere die `i18n` Datensammlung in `src/content/config.ts`, wenn sie nicht bereits konfiguriert ist: +1. Konfiguriere die `i18n` Datensammlung in `src/content.config.ts`, wenn sie nicht bereits konfiguriert ist: - ```diff lang="js" ins=/, (i18nSchema)/ - // src/content/config.ts - import { defineCollection } from 'astro:content'; + ```diff lang="js" ins=/, (i18nLoader|i18nSchema)/ + // src/content.config.ts + import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders'; import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; export const collections = { - docs: defineCollection({ schema: docsSchema() }), - + i18n: defineCollection({ type: 'data', schema: i18nSchema() }), + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), + + i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }), }; ``` @@ -257,14 +257,15 @@ Füge benutzerdefinierte Schlüssel zu den Übersetzungswörterbüchern deiner W Im folgenden Beispiel wird ein neuer, optionaler Schlüssel `custom.label` zu den Standardschlüsseln hinzugefügt: ```diff lang="js" -// src/content/config.ts +// src/content.config.ts import { defineCollection, z } from 'astro:content'; +import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders'; import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; export const collections = { - docs: defineCollection({ schema: docsSchema() }), + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), i18n: defineCollection({ - type: 'data', + loader: i18nLoader(), schema: i18nSchema({ + extend: z.object({ + 'custom.label': z.string().optional(), @@ -274,14 +275,14 @@ export const collections = { }; ``` -Mehr über Inhaltssammlungsschemata erfährst du in [„Ein Sammelschema definieren“](https://docs.astro.build/de/guides/content-collections/#defining-a-collection-schema) in den Astro-Dokumenten. +Mehr über Inhaltssammlungsschemata erfährst du in [„Ein Sammelschema definieren“](https://docs.astro.build/de/guides/content-collections/#defining-the-collection-schema) in den Astro-Dokumenten. ## UI-Übersetzungen verwenden Du kannst auf Starlights [eingebaute UI-Strings](/de/guides/i18n/#starlights-ui-übersetzen) sowie auf [benutzerdefinierte](/de/guides/i18n/#übersetzungsschema-erweitern) und [plugin-provided](/de/reference/plugins/#injecttranslations) UI-Strings über eine einheitliche API zugreifen, die von [i18next](https://www.i18next.com/) unterstützt wird. Dazu gehört die Unterstützung von Funktionen wie [Interpolation](https://www.i18next.com/translation-function/interpolation) und [Pluralisierung](https://www.i18next.com/translation-function/plurals). -In Astro-Komponenten ist diese API als Teil des [globalen `Astro`-Objekts](https://docs.astro.build/de/reference/api-reference/#astrolocals) als `Astro.locals.t` verfügbar: +In Astro-Komponenten ist diese API als Teil des [globalen `Astro`-Objekts](https://docs.astro.build/de/reference/api-reference/#locals) als `Astro.locals.t` verfügbar: ```astro title="example.astro"

@@ -289,7 +290,7 @@ In Astro-Komponenten ist diese API als Teil des [globalen `Astro`-Objekts](https

``` -Du kannst die API auch bei [Endpunkten](https://docs.astro.build/de/guides/endpoints/) verwenden, wo das Objekt `locals` als Teil des [Endpunkt-Kontextes](https://docs.astro.build/de/reference/api-reference/#contextlocals) verfügbar ist: +Du kannst die API auch bei [Endpunkten](https://docs.astro.build/de/guides/endpoints/) verwenden, wo das Objekt `locals` als Teil des [Endpunkt-Kontextes](https://docs.astro.build/de/reference/api-reference/#locals) verfügbar ist: ```ts title="src/pages/404.ts" export const GET = (context) => { @@ -390,7 +391,7 @@ Weitere Informationen findest du in der [`dir()`-Referenz in der i18next-Dokumen ## Zugriff auf das aktuelle Gebietsschema -Du kannst [`Astro.currentLocale`](https://docs.astro.build/de/reference/api-reference/#astrocurrentlocale) verwenden, um das aktuelle Gebietsschema in `.astro` Komponenten zu lesen. +Du kannst [`Astro.currentLocale`](https://docs.astro.build/de/reference/api-reference/#currentlocale) verwenden, um das aktuelle Gebietsschema in `.astro` Komponenten zu lesen. Das folgende Beispiel liest das aktuelle Gebietsschema aus und verwendet es mit Hilfe der [`getRelativeLocaleUrl()`](https://docs.astro.build/de/reference/modules/astro-i18n/#getrelativelocaleurl)-Methode, um einen Link zu einer Informationsseite in der aktuellen Sprache zu erzeugen: diff --git a/docs/src/content/docs/de/guides/project-structure.mdx b/docs/src/content/docs/de/guides/project-structure.mdx index 9a64155953f..20936b8f054 100644 --- a/docs/src/content/docs/de/guides/project-structure.mdx +++ b/docs/src/content/docs/de/guides/project-structure.mdx @@ -10,7 +10,7 @@ Starlight-Projekte folgen im Allgemeinen der gleichen Datei- und Verzeichnisstru ## Dateien und Verzeichnisse - `astro.config.mjs` - Die Astro-Konfigurationsdatei; enthält die Starlight-Integration und -Konfiguration. -- `src/content/config.ts` - Konfigurationsdatei für Inhaltssammlungen; fügt Starlights Frontmatter-Schema zu deinem Projekt hinzu. +- `src/content.config.ts` - Konfigurationsdatei für Inhaltssammlungen; fügt Starlights Frontmatter-Schema zu deinem Projekt hinzu. - `src/content/docs/` - Inhaltsdateien. Starlight verwandelt jede `.md`, `.mdx` oder `.mdoc` Datei in diesem Verzeichnis in eine Seite auf deiner Website. - `src/content/i18n/` (optional) - Übersetzungsdaten zur Unterstützung der [Internationalisierung](/de/guides/i18n/). - `src/` - Anderer Quellcode und Dateien (Komponenten, Stile, Bilder, etc.) für dein Projekt. diff --git a/docs/src/content/docs/de/guides/site-search.mdx b/docs/src/content/docs/de/guides/site-search.mdx index 39c22496b03..3c70e3d2fd8 100644 --- a/docs/src/content/docs/de/guides/site-search.mdx +++ b/docs/src/content/docs/de/guides/site-search.mdx @@ -124,10 +124,10 @@ Füge mithilfe des in Starlight integrierten [Internationalisierungssystems](/de -1. Erweitere die Definition der Starlight-Inhaltssammlung `i18n` um das DocSearch-Schema in `src/content/config.ts`: +1. Erweitere die Definition der Starlight-Inhaltssammlung `i18n` um das DocSearch-Schema in `src/content.config.ts`: ```js ins={4} ins=/{ extend: .+ }/ - // src/content/config.ts + // src/content.config.ts import { defineCollection } from 'astro:content'; import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; import { docSearchI18nSchema } from '@astrojs/starlight-docsearch/schema'; diff --git a/docs/src/content/docs/de/manual-setup.mdx b/docs/src/content/docs/de/manual-setup.mdx index 1dce895f583..a981ea925ef 100644 --- a/docs/src/content/docs/de/manual-setup.mdx +++ b/docs/src/content/docs/de/manual-setup.mdx @@ -62,12 +62,12 @@ Alle verfügbaren Optionen findest du in der [Starlight-Konfigurationsreferenz]( ### Konfigurieren von Inhaltssammlungen -Starlight baut auf Astros [Inhaltssammlungen](https://docs.astro.build/de/guides/content-collections/) auf, die in der Datei `src/content/config.ts` konfiguriert werden. +Starlight baut auf Astros [Inhaltssammlungen](https://docs.astro.build/de/guides/content-collections/) auf, die in der Datei `src/content.config.ts` konfiguriert werden. Erstelle oder aktualisiere die Inhaltskonfigurationsdatei und füge eine `docs`-Sammlung hinzu, die Starlight's `docsSchema` verwendet: ```js ins={3,6} -// src/content/config.ts +// src/content.config.ts import { defineCollection } from 'astro:content'; import { docsSchema } from '@astrojs/starlight/schema'; diff --git a/docs/src/content/docs/de/reference/frontmatter.md b/docs/src/content/docs/de/reference/frontmatter.md index 9884c929f2f..1bb0cc6bf04 100644 --- a/docs/src/content/docs/de/reference/frontmatter.md +++ b/docs/src/content/docs/de/reference/frontmatter.md @@ -399,10 +399,10 @@ sidebar: ## Frontmatter-Schema anpassen -Das Frontmatter-Schema für die Starlight-Inhaltssammlung `docs` wird in `src/content/config.ts` mit dem `docsSchema()`-Helper konfiguriert: +Das Frontmatter-Schema für die Starlight-Inhaltssammlung `docs` wird in `src/content.config.ts` mit dem `docsSchema()`-Helper konfiguriert: ```ts {3,6} -// src/content/config.ts +// src/content.config.ts import { defineCollection } from 'astro:content'; import { docsSchema } from '@astrojs/starlight/schema'; @@ -426,7 +426,7 @@ Der Wert sollte ein [Zod-Schema](https://docs.astro.build/de/guides/content-coll Im folgenden Beispiel geben wir einen strengeren Typ für `description` an, um es zur Pflicht zu machen und fügen ein neues optionales Feld `category` hinzu: ```ts {8-13} -// src/content/config.ts +// src/content.config.ts import { defineCollection, z } from 'astro:content'; import { docsSchema } from '@astrojs/starlight/schema'; @@ -447,7 +447,7 @@ export const collections = { Um die Vorteile der [Astro `image()`-Hilfe](https://docs.astro.build/de/guides/images/#bilder-in-inhaltssammlungen) zu nutzen, verwende eine Funktion, die deine Schemaerweiterung zurückgibt: ```ts {8-13} -// src/content/config.ts +// src/content.config.ts import { defineCollection, z } from 'astro:content'; import { docsSchema } from '@astrojs/starlight/schema'; From da0cc9dc5020fac861cbbf94c5db0ef218dfea72 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:10:44 +0100 Subject: [PATCH 02/13] overriding-components --- docs/src/content/docs/de/guides/overriding-components.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/de/guides/overriding-components.mdx b/docs/src/content/docs/de/guides/overriding-components.mdx index 21b7dc84086..1ad7c89ec3a 100644 --- a/docs/src/content/docs/de/guides/overriding-components.mdx +++ b/docs/src/content/docs/de/guides/overriding-components.mdx @@ -84,7 +84,7 @@ import Default from '@astrojs/starlight/components/SocialIcons.astro'; Beim Rendern einer integrierten Komponente innerhalb einer benutzerdefinierten Komponente: - Verbreite `Astro.props` darin. Dadurch wird sichergestellt, dass es alle Daten erhält, die es zum Rendern benötigt. -- Füge einen [``](https://docs.astro.build/de/core-concepts/astro-components/#slots) innerhalb der Standardkomponente hinzu. Dadurch wird sichergestellt, dass Astro weiß, wo die Komponente gerendert werden muss, wenn der Komponente untergeordnete Elemente übergeben werden. +- Füge einen [``](https://docs.astro.build/de/basics/astro-components/#slots) innerhalb der Standardkomponente hinzu. Dadurch wird sichergestellt, dass Astro weiß, wo die Komponente gerendert werden muss, wenn der Komponente untergeordnete Elemente übergeben werden. Wenn du die Komponenten [`PageFrame`](/de/reference/overrides/#pageframe) oder [`TwoColumnContent`](/de/reference/overrides/#twocolumncontent) wiederverwendst, die [benannte Slots](https://docs.astro.build/de/basics/astro-components/#benannte-slots) enthalten, musst du auch diese Slots [übertragen](https://docs.astro.build/de/basics/astro-components/#slots-weitergeben). @@ -141,7 +141,7 @@ Im folgenden Beispiel zeigt eine Komponente, die Starlights [`Footer`](/de/refer import type { Props } from '@astrojs/starlight/props'; import Default from '@astrojs/starlight/components/Footer.astro'; -const isHomepage = Astro.props.slug === ''; +const isHomepage = Astro.props.id === ''; --- { @@ -155,4 +155,4 @@ const isHomepage = Astro.props.slug === ''; } ``` -Weitere Informationen zum bedingten Rendering findest du im [Astro-Leitfaden zur Vorlagensyntax](https://docs.astro.build/de/core-concepts/astro-syntax/#dynamisches-html). +Weitere Informationen zum bedingten Rendering findest du im [Astro-Leitfaden zur Vorlagensyntax](https://docs.astro.build/de/basics/astro-syntax/#dynamisches-html). From 2f8def37d3fc643e6da34dd24734eba27f248152 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:11:59 +0100 Subject: [PATCH 03/13] project-structure --- docs/src/content/docs/de/guides/project-structure.mdx | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/de/guides/project-structure.mdx b/docs/src/content/docs/de/guides/project-structure.mdx index 20936b8f054..b10e44a470a 100644 --- a/docs/src/content/docs/de/guides/project-structure.mdx +++ b/docs/src/content/docs/de/guides/project-structure.mdx @@ -5,7 +5,7 @@ description: Lerne, wie du Dateien in deinem Starlight-Projekt organisierst. Diese Anleitung zeigt dir, wie ein Starlight-Projekt organisiert ist und was die verschiedenen Dateien in deinem Projekt tun. -Starlight-Projekte folgen im Allgemeinen der gleichen Datei- und Verzeichnisstruktur wie andere Astro-Projekte. Siehe [Astros Dokumentation zur Projektstruktur](https://docs.astro.build/de/core-concepts/project-structure/) für weitere Details. +Starlight-Projekte folgen im Allgemeinen der gleichen Datei- und Verzeichnisstruktur wie andere Astro-Projekte. Siehe [Astros Dokumentation zur Projektstruktur](https://docs.astro.build/de/basics/project-structure/) für weitere Details. ## Dateien und Verzeichnisse @@ -39,8 +39,7 @@ import { FileTree } from '@astrojs/starlight/components'; - 01-getting-started.md - 02-advanced.md - index.mdx - - config.ts - - env.d.ts + - content.config.ts - astro.config.mjs - package.json - tsconfig.json From 2151e1323591b13ead4e5558397ca28a99863913 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:12:57 +0100 Subject: [PATCH 04/13] site-search --- docs/src/content/docs/de/guides/site-search.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/de/guides/site-search.mdx b/docs/src/content/docs/de/guides/site-search.mdx index 3c70e3d2fd8..c2d056f556f 100644 --- a/docs/src/content/docs/de/guides/site-search.mdx +++ b/docs/src/content/docs/de/guides/site-search.mdx @@ -126,16 +126,17 @@ Füge mithilfe des in Starlight integrierten [Internationalisierungssystems](/de 1. Erweitere die Definition der Starlight-Inhaltssammlung `i18n` um das DocSearch-Schema in `src/content.config.ts`: - ```js ins={4} ins=/{ extend: .+ }/ + ```js ins={5} ins=/{ extend: .+ }/ // src/content.config.ts import { defineCollection } from 'astro:content'; + import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders'; import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; import { docSearchI18nSchema } from '@astrojs/starlight-docsearch/schema'; export const collections = { - docs: defineCollection({ schema: docsSchema() }), + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), i18n: defineCollection({ - type: 'data', + loader: i18nLoader(), schema: i18nSchema({ extend: docSearchI18nSchema() }), }), }; From 0efa58413d7f9b8ffcc6d20abf9f1217eed6b488 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:14:38 +0100 Subject: [PATCH 05/13] index --- docs/src/content/docs/de/index.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/content/docs/de/index.mdx b/docs/src/content/docs/de/index.mdx index 868fd5c0dd9..1788ba53160 100644 --- a/docs/src/content/docs/de/index.mdx +++ b/docs/src/content/docs/de/index.mdx @@ -7,6 +7,12 @@ description: Erstelle schöne, leistungsstarke Dokumentations-Webseiten mit Star template: splash editUrl: false lastUpdated: false +banner: + content: | + Aktualisieren auf Astro 5? + + Erfahre, wie es geht + hero: title: Bringe deine Dokumentation mit Starlight zum Leuchten tagline: Alles, was du brauchst, um eine erstklassige Dokumentations-Website zu erstellen. Schnell, barrierefrei und einfach zu bedienen. From f63696a96cf7ee99764d26af1348c9458f19a9ee Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:17:01 +0100 Subject: [PATCH 06/13] manual-setup --- docs/src/content/docs/de/manual-setup.mdx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/src/content/docs/de/manual-setup.mdx b/docs/src/content/docs/de/manual-setup.mdx index a981ea925ef..2c71a245870 100644 --- a/docs/src/content/docs/de/manual-setup.mdx +++ b/docs/src/content/docs/de/manual-setup.mdx @@ -64,18 +64,22 @@ Alle verfügbaren Optionen findest du in der [Starlight-Konfigurationsreferenz]( Starlight baut auf Astros [Inhaltssammlungen](https://docs.astro.build/de/guides/content-collections/) auf, die in der Datei `src/content.config.ts` konfiguriert werden. -Erstelle oder aktualisiere die Inhaltskonfigurationsdatei und füge eine `docs`-Sammlung hinzu, die Starlight's `docsSchema` verwendet: +Erstelle oder aktualisiere die Inhaltskonfigurationsdatei und füge eine `docs`-Sammlung hinzu, die Starlight's `docsLoader` und `docsSchema` verwendet: -```js ins={3,6} +```js ins={3-4,7} // src/content.config.ts import { defineCollection } from 'astro:content'; +import { docsLoader } from '@astrojs/starlight/loaders'; import { docsSchema } from '@astrojs/starlight/schema'; export const collections = { - docs: defineCollection({ schema: docsSchema() }), + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), }; ``` +Starlight unterstützt auch die Option [`legacy.collections`] (https://docs.astro.build/en/reference/legacy-flags/), bei dem Sammlungen mit der Legacy-Implementierung von Inhaltssammlungen behandelt werden. +Dies ist nützlich, wenn du ein bestehendes Astro-Projekt hast und zum jetzigen Zeitpunkt keine Änderungen an den Sammlungen vornehmen kannst, um einen Loader zu verwenden. + ### Inhalte hinzufügen Starlight ist jetzt konfiguriert und du kannst Inhalte hinzuzufügen. @@ -125,6 +129,6 @@ Für die Zukunft planen wir, diesen Anwendungsfall besser zu unterstützen, um d ### Starlight mit SSR verwenden -Um SSR zu aktivieren, folge der Anleitung [„Serverseitiges Rendern (SSR)“](https://docs.astro.build/de/guides/server-side-rendering/) in der Astro-Dokumentation, um einen Server-Adapter zu deinem Starlight-Projekt hinzuzufügen. +Um SSR zu aktivieren, folge der Anleitung [„Serverseitiges Rendern (SSR)“](https://docs.astro.build/de/guides/on-demand-rendering/) in der Astro-Dokumentation, um einen Server-Adapter zu deinem Starlight-Projekt hinzuzufügen. Die von Starlight erzeugten Dokumentationsseiten werden standardmäßig vorgerendert, unabhängig vom Ausgabemodus deines Projekts. Wenn du nicht möchtest, dass deine Starlight-Seiten vorgerendert werden, setze die [Konfigurationsoption `prerender`](/de/reference/configuration/#prerender) auf `false`. From 98c4252674ea2bb5563dac1930b58d798fe98b24 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:17:53 +0100 Subject: [PATCH 07/13] configuration --- docs/src/content/docs/de/reference/configuration.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/de/reference/configuration.mdx b/docs/src/content/docs/de/reference/configuration.mdx index 303cc1c24f7..44451e4ba45 100644 --- a/docs/src/content/docs/de/reference/configuration.mdx +++ b/docs/src/content/docs/de/reference/configuration.mdx @@ -464,7 +464,7 @@ Pagefind kann nicht aktiviert werden, wenn die Option [`prerender`](#prerender) **Typ:** `boolean` **Standard:** `true` -Lege fest, ob Starlight-Seiten vorgerendert zu statischem HTML oder bei Bedarf von einem [SSR-Adapter](https://docs.astro.build/de/guides/server-side-rendering/) gerendert werden sollen. +Lege fest, ob Starlight-Seiten vorgerendert zu statischem HTML oder bei Bedarf von einem [SSR-Adapter](https://docs.astro.build/de/guides/on-demand-rendering/) gerendert werden sollen. Starlight-Seiten werden standardmäßig vorgerendert. Wenn du einen SSR-Adapter verwendest und Starlight-Seiten bei Bedarf rendern möchtest, setze `prerender: false`. @@ -570,7 +570,7 @@ Zum Beispiel heißt diese Seite „Konfigurationsreferenz“ und diese Website h **Typ:** `Boolean` **Standard:** `false` -Deaktiviert die Einspeisung von Starlights Standard [404 Seite](https://docs.astro.build/en/core-concepts/astro-pages/#custom-404-error-page). Um eine eigene `src/pages/404.astro`-Route in deinem Projekt zu verwenden, setze diese Option auf `true`. +Deaktiviert die Einspeisung von Starlights Standard [404 Seite](https://docs.astro.build/en/basics/astro-pages/#custom-404-error-page). Um eine eigene `src/pages/404.astro`-Route in deinem Projekt zu verwenden, setze diese Option auf `true`. ### `components` From b7674a513140c5417240205c0008e6eb024ea4ed Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:20:20 +0100 Subject: [PATCH 08/13] frontmatter --- .../content/docs/de/reference/frontmatter.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/src/content/docs/de/reference/frontmatter.md b/docs/src/content/docs/de/reference/frontmatter.md index 1bb0cc6bf04..f62c621ed14 100644 --- a/docs/src/content/docs/de/reference/frontmatter.md +++ b/docs/src/content/docs/de/reference/frontmatter.md @@ -35,7 +35,7 @@ Die Seitenbeschreibung wird für die Metadaten der Seite verwendet und wird von **Typ**: `string` -Setzt den Slug der Seite außer Kraft. Siehe [„Benutzerdefinierte Slugs definieren“](https://docs.astro.build/de/guides/content-collections/#defining-custom-slugs) in der Astro-Dokumentation für weitere Details. +Setzt den Slug der Seite außer Kraft. Siehe [„Benutzerdefinierte IDs definieren“](https://docs.astro.build/de/guides/content-collections/#defining-custom-ids) in der Astro-Dokumentation für weitere Details. ### `editUrl` @@ -401,17 +401,18 @@ sidebar: Das Frontmatter-Schema für die Starlight-Inhaltssammlung `docs` wird in `src/content.config.ts` mit dem `docsSchema()`-Helper konfiguriert: -```ts {3,6} +```ts {4,7} // src/content.config.ts import { defineCollection } from 'astro:content'; +import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders'; import { docsSchema } from '@astrojs/starlight/schema'; export const collections = { - docs: defineCollection({ schema: docsSchema() }), + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), }; ``` -Mehr über Schemata für Inhaltssammlungen erfährst du in [„Definieren eines Sammelschemas“](https://docs.astro.build/de/guides/content-collections/#definieren-eines-sammelschemas) in den Astro-Dokumenten. +Mehr über Schemata für Inhaltssammlungen erfährst du in [„Definieren eines Sammelschemas“](https://docs.astro.build/de/guides/content-collections/#defining-the-collection-schema) in den Astro-Dokumenten. `docsSchema()` nimmt die folgenden Optionen an: @@ -425,13 +426,15 @@ Der Wert sollte ein [Zod-Schema](https://docs.astro.build/de/guides/content-coll Im folgenden Beispiel geben wir einen strengeren Typ für `description` an, um es zur Pflicht zu machen und fügen ein neues optionales Feld `category` hinzu: -```ts {8-13} +```ts {10-15} // src/content.config.ts import { defineCollection, z } from 'astro:content'; +import { docsLoader } from '@astrojs/starlight/loaders'; import { docsSchema } from '@astrojs/starlight/schema'; export const collections = { docs: defineCollection({ + loader: docsLoader(), schema: docsSchema({ extend: z.object({ // Mache ein eingebautes Feld erforderlich statt optional. @@ -446,13 +449,15 @@ export const collections = { Um die Vorteile der [Astro `image()`-Hilfe](https://docs.astro.build/de/guides/images/#bilder-in-inhaltssammlungen) zu nutzen, verwende eine Funktion, die deine Schemaerweiterung zurückgibt: -```ts {8-13} +```ts {10-15} // src/content.config.ts import { defineCollection, z } from 'astro:content'; +import { docsLoader } from '@astrojs/starlight/loaders'; import { docsSchema } from '@astrojs/starlight/schema'; export const collections = { docs: defineCollection({ + loader: docsLoader(), schema: docsSchema({ extend: ({ image }) => { return z.object({ From 542193acf45cef9b868a60480d55c19cd378d88e Mon Sep 17 00:00:00 2001 From: trueberryless Date: Mon, 16 Dec 2024 17:24:54 +0100 Subject: [PATCH 09/13] overrides and some replacements and fixes --- .../src/content/docs/de/guides/overriding-components.mdx | 4 ++-- docs/src/content/docs/de/manual-setup.mdx | 2 +- docs/src/content/docs/de/reference/configuration.mdx | 2 +- docs/src/content/docs/de/reference/overrides.md | 9 ++++++--- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/src/content/docs/de/guides/overriding-components.mdx b/docs/src/content/docs/de/guides/overriding-components.mdx index 1ad7c89ec3a..23193c8a841 100644 --- a/docs/src/content/docs/de/guides/overriding-components.mdx +++ b/docs/src/content/docs/de/guides/overriding-components.mdx @@ -5,7 +5,7 @@ description: In Starlight kannst du eingebauten Komponenten ersetzen, um eigene import { Steps } from '@astrojs/starlight/components'; -Starlight's Standard-UI und Konfigurationsoptionen sind so gestaltet, dass sie flexibel sind und für eine Reihe von Inhalten funktionieren. Ein Großteil des Standardaussehens von Starlight kann mit [CSS](/de/guides/css-and-tailwind/) und [Konfigurationsoptionen](/de/guides/customization/) angepasst werden. +Starlights Standard-UI und Konfigurationsoptionen sind so gestaltet, dass sie flexibel sind und für eine Reihe von Inhalten funktionieren. Ein Großteil des Standardaussehens von Starlight kann mit [CSS](/de/guides/css-and-tailwind/) und [Konfigurationsoptionen](/de/guides/customization/) angepasst werden. Wenn du mehr brauchst als das, was von Haus aus möglich ist, unterstützt Starlight die Erstellung eigener Komponenten, um die Standardkomponenten zu erweitern oder zu ersetzen. @@ -25,7 +25,7 @@ Die Standardkomponenten von Starlight zu überschreiben kann nützlich sein, wen Du kannst eine vollständige Liste der Komponenten in der [Komponenten-Ersetzung Referenz](/de/reference/overrides/) finden. :::tip - Du bist dir nicht sicher, welche Komponente du überschreiben musst? Benutze die [interaktive Starlight Overrides Map](https://starlight-overrides-map.netlify.app/), um die Namen von Starlight's UI-Komponenten zu erfahren. + Du bist dir nicht sicher, welche Komponente du überschreiben musst? Benutze die [interaktive Starlight Overrides Map](https://starlight-overrides-map.netlify.app/), um die Namen von Starlights UI-Komponenten zu erfahren. ::: In diesem Beispiel wird die Starlight-Komponente [`SocialIcons`](/de/reference/overrides/#socialicons) in der Navigationsleiste der Seite außer Kraft gesetzt. diff --git a/docs/src/content/docs/de/manual-setup.mdx b/docs/src/content/docs/de/manual-setup.mdx index 2c71a245870..46c60bb0f04 100644 --- a/docs/src/content/docs/de/manual-setup.mdx +++ b/docs/src/content/docs/de/manual-setup.mdx @@ -64,7 +64,7 @@ Alle verfügbaren Optionen findest du in der [Starlight-Konfigurationsreferenz]( Starlight baut auf Astros [Inhaltssammlungen](https://docs.astro.build/de/guides/content-collections/) auf, die in der Datei `src/content.config.ts` konfiguriert werden. -Erstelle oder aktualisiere die Inhaltskonfigurationsdatei und füge eine `docs`-Sammlung hinzu, die Starlight's `docsLoader` und `docsSchema` verwendet: +Erstelle oder aktualisiere die Inhaltskonfigurationsdatei und füge eine `docs`-Sammlung hinzu, die Starlights `docsLoader` und `docsSchema` verwendet: ```js ins={3-4,7} // src/content.config.ts diff --git a/docs/src/content/docs/de/reference/configuration.mdx b/docs/src/content/docs/de/reference/configuration.mdx index 44451e4ba45..1f46a8f64ea 100644 --- a/docs/src/content/docs/de/reference/configuration.mdx +++ b/docs/src/content/docs/de/reference/configuration.mdx @@ -452,7 +452,7 @@ Wenn du benutzerdefinierte Themes verwendest und dies auf `true` setzt, musst du **Typ:** `boolean` **Standard:** `true` -Lege fest, ob Starlight's Standard-Site-Search-Anbieter [Pagefind](https://pagefind.app/) aktiviert ist. +Lege fest, ob Starlights Standard-Site-Search-Anbieter [Pagefind](https://pagefind.app/) aktiviert ist. Setze diese Option auf `false`, um die Indizierung deiner Website mit Pagefind zu deaktivieren. Dadurch wird auch die Standard-Suchoberfläche ausgeblendet, falls sie verwendet wird. diff --git a/docs/src/content/docs/de/reference/overrides.md b/docs/src/content/docs/de/reference/overrides.md index 5c606fab6f0..0e14fff553a 100644 --- a/docs/src/content/docs/de/reference/overrides.md +++ b/docs/src/content/docs/de/reference/overrides.md @@ -7,7 +7,7 @@ sidebar: label: Ersetzung von Komponenten --- -Du kannst Starlight's eingebaute Komponenten überschreiben, indem du Pfade zu Ersatzkomponenten in Starlight's [`components`](/de/reference/configuration/#components)-Konfigurationsoption angibst. +Du kannst Starlights eingebaute Komponenten überschreiben, indem du Pfade zu Ersatzkomponenten in Starlights [`components`](/de/reference/configuration/#components)-Konfigurationsoption angibst. Diese Seite listet alle Komponenten auf, die überschrieben werden können, und verweist auf ihre Standardimplementierungen auf GitHub. Erfahre mehr in der [Anleitung zum Überschreiben von Komponenten](/de/guides/overriding-components/). @@ -71,11 +71,14 @@ Bei mehrsprachigen Websites wird hier das aktuelle Gebietsschema angegeben, z. B 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` -Die eindeutige ID für diese Seite auf der Grundlage des Dateinamens des Inhalts. +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` @@ -242,7 +245,7 @@ Die Standardimplementierung enthält die Logik für die Darstellung von Logos, d **Standardkomponente:** [`Search.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Search.astro) -Diese Komponente wird verwendet, um Starlight's Suchoberfläche darzustellen. +Diese Komponente wird verwendet, um Starlights Suchoberfläche darzustellen. Die Standardimplementierung enthält die Schaltfläche in der Kopfzeile und den Code für die Anzeige eines Suchmodals, wenn darauf geklickt wird, und das Laden von [Pagefinds UI](https://pagefind.app/). Wenn [`pagefind`](/de/reference/configuration/#pagefind) deaktiviert ist, wird die Standard-Suchkomponente nicht angezeigt. From 01b9ccefb7602418b08c9b8edfe18650983a1c43 Mon Sep 17 00:00:00 2001 From: trueberryless <99918022+trueberryless@users.noreply.github.com> Date: Mon, 16 Dec 2024 20:52:02 +0100 Subject: [PATCH 10/13] Update docs/src/content/docs/de/guides/i18n.mdx Co-authored-by: Chris Swithinbank --- docs/src/content/docs/de/guides/i18n.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/src/content/docs/de/guides/i18n.mdx b/docs/src/content/docs/de/guides/i18n.mdx index f44c86fa551..efde3713837 100644 --- a/docs/src/content/docs/de/guides/i18n.mdx +++ b/docs/src/content/docs/de/guides/i18n.mdx @@ -192,6 +192,7 @@ Du kannst Übersetzungen für zusätzliche Sprachen, die du unterstützt, über ```diff lang="js" ins=/, (i18nLoader|i18nSchema)/ // src/content.config.ts + import { defineCollection } from 'astro:content'; import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders'; import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; From edcbafea416dc469526e68de720077bd688dcb2e Mon Sep 17 00:00:00 2001 From: trueberryless <99918022+trueberryless@users.noreply.github.com> Date: Mon, 16 Dec 2024 20:52:32 +0100 Subject: [PATCH 11/13] Update docs/src/content/docs/de/manual-setup.mdx Co-authored-by: Chris Swithinbank --- docs/src/content/docs/de/manual-setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/de/manual-setup.mdx b/docs/src/content/docs/de/manual-setup.mdx index 46c60bb0f04..c9c8863a53d 100644 --- a/docs/src/content/docs/de/manual-setup.mdx +++ b/docs/src/content/docs/de/manual-setup.mdx @@ -77,7 +77,7 @@ export const collections = { }; ``` -Starlight unterstützt auch die Option [`legacy.collections`] (https://docs.astro.build/en/reference/legacy-flags/), bei dem Sammlungen mit der Legacy-Implementierung von Inhaltssammlungen behandelt werden. +Starlight unterstützt auch die Option [`legacy.collections`] (https://docs.astro.build/de/reference/legacy-flags/), bei dem Sammlungen mit der Legacy-Implementierung von Inhaltssammlungen behandelt werden. Dies ist nützlich, wenn du ein bestehendes Astro-Projekt hast und zum jetzigen Zeitpunkt keine Änderungen an den Sammlungen vornehmen kannst, um einen Loader zu verwenden. ### Inhalte hinzufügen From 9b6bb662df4a3cf32b5b21787d258a2ac7347116 Mon Sep 17 00:00:00 2001 From: trueberryless <99918022+trueberryless@users.noreply.github.com> Date: Mon, 16 Dec 2024 20:52:54 +0100 Subject: [PATCH 12/13] Update docs/src/content/docs/de/reference/configuration.mdx Co-authored-by: Chris Swithinbank --- docs/src/content/docs/de/reference/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/de/reference/configuration.mdx b/docs/src/content/docs/de/reference/configuration.mdx index 1f46a8f64ea..69831f45e55 100644 --- a/docs/src/content/docs/de/reference/configuration.mdx +++ b/docs/src/content/docs/de/reference/configuration.mdx @@ -570,7 +570,7 @@ Zum Beispiel heißt diese Seite „Konfigurationsreferenz“ und diese Website h **Typ:** `Boolean` **Standard:** `false` -Deaktiviert die Einspeisung von Starlights Standard [404 Seite](https://docs.astro.build/en/basics/astro-pages/#custom-404-error-page). Um eine eigene `src/pages/404.astro`-Route in deinem Projekt zu verwenden, setze diese Option auf `true`. +Deaktiviert die Einspeisung von Starlights Standard [404 Seite](https://docs.astro.build/de/basics/astro-pages/#benutzerdefinierte-404-fehlerseite). Um eine eigene `src/pages/404.astro`-Route in deinem Projekt zu verwenden, setze diese Option auf `true`. ### `components` From f77fef778b93f904896612ef99f9a79ec03001c1 Mon Sep 17 00:00:00 2001 From: trueberryless <99918022+trueberryless@users.noreply.github.com> Date: Mon, 16 Dec 2024 20:56:36 +0100 Subject: [PATCH 13/13] fix link --- docs/src/content/docs/de/manual-setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/content/docs/de/manual-setup.mdx b/docs/src/content/docs/de/manual-setup.mdx index c9c8863a53d..9f2cfa364e7 100644 --- a/docs/src/content/docs/de/manual-setup.mdx +++ b/docs/src/content/docs/de/manual-setup.mdx @@ -77,7 +77,7 @@ export const collections = { }; ``` -Starlight unterstützt auch die Option [`legacy.collections`] (https://docs.astro.build/de/reference/legacy-flags/), bei dem Sammlungen mit der Legacy-Implementierung von Inhaltssammlungen behandelt werden. +Starlight unterstützt auch die Option [`legacy.collections`](https://docs.astro.build/de/reference/legacy-flags/), bei dem Sammlungen mit der Legacy-Implementierung von Inhaltssammlungen behandelt werden. Dies ist nützlich, wenn du ein bestehendes Astro-Projekt hast und zum jetzigen Zeitpunkt keine Änderungen an den Sammlungen vornehmen kannst, um einen Loader zu verwenden. ### Inhalte hinzufügen