-
-
Notifications
You must be signed in to change notification settings - Fork 562
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
i18n(de): translate guides/pages (#2469)
Co-authored-by: HiDeoo <[email protected]>
- Loading branch information
1 parent
3229256
commit f579228
Showing
1 changed file
with
178 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
--- | ||
title: Seiten | ||
description: Lerne, wie du mit Starlight die Seiten deiner Dokumentationsseite erstellst und verwaltest. | ||
sidebar: | ||
order: 1 | ||
--- | ||
|
||
Starlight generiert die HTML-Seiten deiner Website auf der Grundlage deines Inhalts, wobei flexible Optionen über das Markdown-Frontmatter bereitgestellt werden. | ||
Außerdem haben Starlight-Projekte vollen Zugriff auf [Astros leistungsstarke Werkzeuge zur Seitengenerierung](https://docs.astro.build/de/basics/astro-pages/). | ||
Dieser Leitfaden zeigt, wie die Seitenerstellung in Starlight funktioniert. | ||
|
||
## Seiten mit Inhalten | ||
|
||
### Dateiformate | ||
|
||
Starlight unterstützt das Verfassen von Inhalten in Markdown und MDX, ohne dass eine Konfiguration erforderlich ist. | ||
Du kannst die Unterstützung für Markdoc hinzufügen, indem du dem [„Markdoc“ Leitfaden](/de/guides/authoring-content/#markdoc) folgst. | ||
|
||
### Seiten hinzufügen | ||
|
||
Füge neue Seiten zu deiner Website hinzu, indem du `.md` oder `.mdx` Dateien in `src/content/docs/` erstellst. | ||
Verwende Unterordner, um deine Dateien zu organisieren und um mehrere Pfadsegmente zu erstellen. | ||
|
||
Die folgende Dateistruktur erzeugt zum Beispiel Seiten unter `example.com/hello-world` und `example.com/reference/faq`: | ||
|
||
import { FileTree } from '@astrojs/starlight/components'; | ||
|
||
<FileTree> | ||
|
||
- src/ | ||
- content/ | ||
- docs/ | ||
- hello-world.md | ||
- reference/ | ||
- faq.md | ||
|
||
</FileTree> | ||
|
||
### Typsicheres Frontmatter | ||
|
||
Alle Starlight-Seiten haben ein anpassbares [gemeinsames Set von Frontmatter-Eigenschaften](/de/reference/frontmatter/), um zu steuern, wie die Seite aussieht: | ||
|
||
```md | ||
--- | ||
title: Hallo, Welt! | ||
description: Dies ist eine Seite in meiner Starlight-Website | ||
--- | ||
``` | ||
|
||
Wenn du etwas Wichtiges vergisst, lässt Starlight dich das wissen. | ||
|
||
## Benutzerdefinierte Seiten | ||
|
||
Für fortgeschrittene Anwendungsfälle kannst du benutzerdefinierte Seiten hinzufügen, indem du ein Verzeichnis `src/pages/` erstellst. | ||
Das Verzeichnis `src/pages/` verwendet [Astros dateibasiertes Routing](https://docs.astro.build/de/basics/astro-pages/#dateibasiertes-routing) und unterstützt neben anderen Seitenformaten auch `.astro`-Dateien. | ||
Das ist hilfreich, wenn du Seiten mit einem völlig eigenen Layout erstellen oder eine Seite aus einer anderen Datenquelle generieren willst. | ||
|
||
In diesem Projekt werden zum Beispiel Markdown-Inhalte in `src/content/docs/` mit Astro- und HTML-Routen in `src/pages/` gemischt: | ||
|
||
<FileTree> | ||
|
||
- src/ | ||
- content/ | ||
- docs/ | ||
- hello-world.md | ||
- pages/ | ||
- custom.astro | ||
- archived.html | ||
|
||
</FileTree> | ||
|
||
Mehr dazu findest du in der [„Seiten“-Anleitung in den Astro-Dokumenten](https://docs.astro.build/de/basics/astro-pages/). | ||
|
||
### Das Starlight-Design in eigenen Seiten verwenden | ||
|
||
Um das Starlight-Layout in benutzerdefinierten Seiten zu verwenden, umhüllst du deinen Seiteninhalt mit der Komponente `<StarlightPage />`. | ||
Das kann hilfreich sein, wenn du Inhalte dynamisch generierst, aber trotzdem das Starlight-Design verwenden willst. | ||
|
||
```astro | ||
--- | ||
// src/pages/custom-page/example.astro | ||
import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro'; | ||
import CustomComponent from './CustomComponent.astro'; | ||
--- | ||
<StarlightPage frontmatter={{ title: 'Meine eigene Seite' }}> | ||
<p> | ||
Dies ist eine benutzerdefinierte Seite mit einer benutzerdefinierten | ||
Komponente: | ||
</p> | ||
<CustomComponent /> | ||
</StarlightPage> | ||
``` | ||
|
||
#### Eigenschaften | ||
|
||
Die Komponente `<StarlightPage />` akzeptiert die folgenden Eigenschaften. | ||
|
||
##### `frontmatter` (erforderlich) | ||
|
||
**Typ:** `StarlightPageFrontmatter` | ||
|
||
Setzt die [Frontmatter Eigenschaften](/de/reference/frontmatter/) für diese Seite, ähnlich wie Frontmatter in Markdown-Seiten. | ||
Die Eigenschaft [`title`](/de/reference/frontmatter/#title-erforderlich) ist erforderlich und alle anderen Eigenschaften sind optional. | ||
|
||
Die folgenden Eigenschaften unterscheiden sich von Markdown frontmatter: | ||
|
||
- Die Eigenschaft [`slug`](/de/reference/frontmatter/#slug) wird nicht unterstützt und wird automatisch anhand der URL der benutzerdefinierten Seite gesetzt. | ||
- Die Option [`editUrl`](/de/reference/frontmatter/#editurl) erfordert eine URL, um einen Bearbeitungslink anzuzeigen. | ||
- Die Frontmatter-Eigenschaft [`sidebar`](/de/reference/frontmatter/#sidebar), mit der du festlegen kannst, wie die Seite in [autogenerierten Linkgruppen](/de/reference/configuration/#sidebar) erscheint, ist nicht verfügbar. Seiten, die die Komponente `<StarlightPage />` verwenden, sind nicht Teil einer Sammlung und können nicht zu einer automatisch erzeugten Seitenleistengruppe hinzugefügt werden. | ||
- Die Option [`draft`](/de/reference/frontmatter/#draft) zeigt nur einen [Hinweis](/de/reference/overrides/#draftcontentnotice) an, dass die Seite ein Entwurf ist, schließt sie aber nicht automatisch von der Produktion aus. | ||
|
||
##### `sidebar` | ||
|
||
**Typ:** [`SidebarItem[]`](/de/reference/configuration/#sidebaritem) | ||
**Voreinstellung:** die Seitenleiste, die auf der Grundlage der [globalen `Sidebar`-Konfiguration](/de/reference/configuration/#sidebar) erzeugt wird | ||
|
||
Legt eine benutzerdefinierte Navigationsleiste für diese Seite fest. | ||
Wenn sie nicht gesetzt wird, verwendet die Seite die globale Standard-Seitenleiste. | ||
|
||
Die folgende Seite ersetzt zum Beispiel die Standard-Seitenleiste durch einen Link zur Homepage und eine Gruppe von Links zu verschiedenen anderen benutzerdefinierten Seiten. | ||
|
||
```astro {3-13} | ||
<StarlightPage | ||
frontmatter={{ title: 'Orion' }} | ||
sidebar={[ | ||
{ label: 'Home', link: '/' }, | ||
{ | ||
label: 'Constellations', | ||
items: [ | ||
{ label: 'Andromeda', link: '/andromeda/' }, | ||
{ label: 'Orion', link: '/orion/' }, | ||
{ label: 'Ursa Minor', link: '/ursa-minor/', badge: 'Platzhalter' }, | ||
], | ||
}, | ||
]} | ||
> | ||
Beispielinhalt. | ||
</StarlightPage> | ||
``` | ||
|
||
In der Anleitung [„Seitenleisten-Navigation“](/de/guides/sidebar/) erfährst du mehr über die verfügbaren Optionen zum Anpassen der Seitenleiste. | ||
|
||
##### `hasSidebar` | ||
|
||
**Typ:** `boolean` | ||
**Voreinstellung:** `false` wenn [`frontmatter.template`](/de/reference/frontmatter/#template) `'splash'` ist, sonst `true` | ||
|
||
Legt fest, ob die Seitenleiste auf dieser Seite angezeigt werden soll oder nicht. | ||
|
||
##### `headings` | ||
|
||
**Typ:** `{ depth: number; slug: string; text: string }[]` | ||
**Voreinstellung:** `[]` | ||
|
||
Gib ein Array mit allen Überschriften auf dieser Seite an. | ||
Starlight wird das Inhaltsverzeichnis der Seite aus diesen Überschriften generieren, wenn sie angegeben sind. | ||
|
||
##### `dir` | ||
|
||
**Typ:** `'ltr' | 'rtl'` | ||
**Voreinstellung:** die Schreibrichtung für das aktuelle Gebietsschema | ||
|
||
Legt die Schreibrichtung für den Inhalt dieser Seite fest. | ||
|
||
##### `lang` | ||
|
||
**Typ:** `String` | ||
**Voreinstellung:** die Sprache des aktuellen Gebietsschemas | ||
|
||
Setzt das BCP-47 Sprach-Tag für den Inhalt dieser Seite, z.B. `en`, `zh-CN` oder `pt-BR`. | ||
|
||
##### `isFallback` | ||
|
||
**Typ:** `boolean` | ||
**Voreinstellung:** `false` | ||
|
||
Gibt an, ob diese Seite [Fallback-Inhalt](/de/guides/i18n/#fallback-inhalt) verwendet, weil es für die aktuelle Sprache keine Übersetzung gibt. |