Zum Inhalt springen
Starlight

Erste Schritte

Erstelle ein neues Projekt

Starlight ist ein voll ausgestattetes Dokumentations-Theme, das auf dem Astro Framework aufbaut.

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

Terminal-Fenster
# Erstelle ein neues Projekt mit npm
npm create astro@latest -- --template starlight

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

Inhalte mit Starlight erstellen

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

Dateiformate

Starlight unterstützt das Erstellen von Inhalten in Markdown und MDX. (Du kannst die experimentelle Astro Markdoc Integration installieren, um Markdoc zu unterstützen.)

Seiten hinzufügen

Füge neue Seiten zu deiner Website automatisch hinzu, indem du .md oder .mdx Dateien in src/content/docs/ erstellst. Erstelle Unterordner, um deine Dateien zu organisieren und mehrere Pfadsegmente zu erstellen:

src/content/docs/hello-world.md => your-site.com/hello-world
src/content/docs/guides/faq.md => your-site.com/guides/faq

Typsichere Frontmatter

Alle Starlight Seiten teilen sich anpassbare Frontmatter-Eigenschaften, mit denen das Erscheinungsbild der Seite gesteuert wird:

---
title: Hello, World!
description: This is a page in my Starlight-powered site
---

Wenn du etwas Wichtiges vergisst, wird Starlight dich daran erinnern.

Veröffentlichung deiner Starlight-Website

Sobald du deine Starlight Website erstellt und angepasst hast, kannst du sie auf einen Webserver oder Hosting-Plattform deiner Wahl veröffentlichen, einschließlich Netlify, Vercel, GitHub Pages und vielen mehr.

Lerne mehr über die Veröffentlichung einer Astro-Website in der Astro-Dokumentation.

Starlight aktualisieren

Starlight ist eine Astro-Integration und wird wie jede @astrojs/*-Integration aktualisiert:

Terminal-Fenster
# Starlight mit npm aktualisieren
npm install @astrojs/starlight@latest

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

Fehlerbehebung

Sowohl die Starlight Projektkonfiguration als auch die Konfiguration einzelner Seiten findest du im Referenzbereich dieser Website. Nutze diese Seiten, um sicherzustellen, dass deine Starlight-Site richtig konfiguriert ist und funktioniert.

In der wachsenden Liste der Anleitungen in der Seitenleiste findest du Hilfe beim Hinzufügen von Inhalten und beim Anpassen deiner Starlight-Website.

Wenn du keine Antwort in dieser Dokumentation finden kannst, besuche bitte die Astro Docs für die vollständige Astro-Dokumentation. Deine Frage kann vielleicht beantwortet werden, wenn du verstehst, wie Astro im Allgemeinen funktioniert.

Du kannst auch nach bekannten Starlight-Problemen auf GitHub suchen und im Astro Discord Hilfe von unserer aktiven, freundlichen Community erhalten! Du kannst Fragen in unserem #Support-Forum stellen oder unseren speziellen #starlight-Channel besuchen, um aktuelle Entwicklungen und mehr zu diskutieren.