Erste Schritte

Starlight ist ein voll funktionsfähiges Dokumentationsframework, welches auf Astro aufbaut. Diese Anleitung wird dir helfen, mit einem neuen Projekt zu beginnen. Siehe dir die manuellen Einrichtungsanweisungen an, um Starlight zu einem bestehenden Astro-Projekt hinzuzufügen.

Schnellstart

Erstelle ein neues Projekt

Du kannst ein neues Astro + Starlight Projekt mit dem folgenden Befehl erstellen:

npm create astro@latest -- --template starlight

pnpm create astro --template starlight

yarn create astro --template starlight

Damit wird ein neues Projektverzeichnis mit allen erforderlichen Dateien und Konfigurationen für deine Website erstellt.

Starte den Entwicklungsserver

Wenn du lokal arbeitest, kannst du mit dem Astro-Entwicklungsserver eine Vorschau deiner Arbeit angezeigt bekommen und dein Browser wird automatisch aktualisiert, wenn du Änderungen vornimmst.

Führe in deinem Projektverzeichnis den folgenden Befehl aus, um den Entwicklungsserver zu starten:

npm run dev

pnpm dev

yarn dev

Daraufhin wird eine Meldung mit der URL deiner lokalen Vorschau in deinem Terminal angezeigt. Öffne diese URL, um deine Website zu betrachten.

Inhalt hinzufügen

Starlight ist bereit für dich, neuen Inhalt hinzuzufügen oder deine vorhandenen Dateien mitzubringen!

Füge neue Seiten zu deiner Website hinzu, indem du Markdown-Dateien im Verzeichnis src/content/docs/ erstellst.

Lies mehr über dateibasiertes Routing und Unterstützung für MDX- und Markdoc-Dateien in der Anleitung „Seiten“.

Nächste Schritte

Konfigurieren: Erfahre mehr über die allgemeinen Optionen in „Starlight anpassen“.
Navigieren: Richte dir deine Seitenleiste mit der Anleitung „Seitenleisten-Navigation“ ein.
Komponenten: Entdecke die eingebauten Karten, Registerkarten und mehr in der Anleitung „Komponenten“.
Veröffentlichen: Veröffentliche deine Arbeit mit der Anleitung „Bereitstellen deiner Website“ in den Astro-Dokumenten.

Starlight aktualisieren

Starlight ist eine Astro-Integration. Dieses und andere Astro-Pakete kannst du aktualisieren, indem du den folgenden Befehl in deinem Terminal ausführst:

npx @astrojs/upgrade

pnpm dlx @astrojs/upgrade

yarn dlx @astrojs/upgrade

Eine vollständige Liste der Änderungen findest du im Starlight Changelog.

Fehlerbehebung Starlight

Benutze die Referenzseiten Projektkonfiguration und Individuelle Seitenfrontmatter-Konfiguration, um sicherzustellen, dass deine Starlight-Site richtig konfiguriert ist und funktioniert. In den Anleitungen in der Seitenleiste findest du Hilfe beim Hinzufügen von Inhalten und Anpassen deiner Starlight-Site.

Wenn du deine Antwort nicht in diesen Dokumenten finden kannst, besuche bitte die Astro-Dokumentation für eine vollständige Dokumentation des darunterliegenden Frameworks. Deine Frage lässt sich vielleicht beantworten, wenn du verstehst, wie Astro im Allgemeinen funktioniert, da Astro das Framework ist, auf dem Starlight basiert.

Du kannst auch nach bekannten Starlight-Problemen auf GitHub suchen und im Astro Discord Hilfe von unserer aktiven, freundlichen Community erhalten! Poste Fragen in unserem #support Forum mit dem „starlight“ Tag, oder besuche unseren speziellen #starlight Kanal, um über die aktuelle Entwicklung und mehr zu diskutieren!