Ersteinrichtung

1. Installieren Sie zunachst alle erforderlichen Pakete mit npm install oder pnpm install, und fuehren Sie dann einen ersten Build durch, um sicherzustellen, dass die Einrichtung funktioniert: npm run build oder pnpm build.
2. Kopieren Sie den Pagefind-Build (fuer die Seitensuche), damit er in der Entwicklungsumgebung verfuegbar ist. Dies variiert je nach Betriebssystem. Es gibt einige hilfreiche Befehle:
   • Fuer Windows: npm run winsearch
   • Fuer OSX oder Linux: npm run osxsearch
3. Als Naechstes konfigurieren Sie die i18n-Einrichtung Ihrer Seite (eine oder mehrere Sprachen). Fuehren Sie einfach den Befehl npm run docs:config-i18n aus und folgen Sie den Anweisungen des Skripts!
4. Jetzt koennen Sie die Seite nach Ihren Wuenschen einrichten!

Code-Einfuehrungen

Es wurden einige Code-Touren erstellt, um Ihnen die Codebasis vorzustellen. Sie benoetigen die Erweiterung Code Tour, um sie in VSCode oder einer anderen IDE anzuzeigen.

Code-Struktur

Der Code ist so strukturiert, dass sich die meisten Elemente im Verzeichnis src/docs befinden. Dies erleichtert es, den gesamten Ordner in ein bestehendes Projekt einzufuegen und die Dokumentationsfunktionalitaet in wenigen Minuten hinzuzufuegen.

Konfigurationsoptionen

Die allgemeine Seitenkonfiguration erfolgt im Ordner src/docs/config/. Die meisten Einstellungen befinden sich in einzelnen Sprachordnern, um die Handhabung von Uebersetzungen zu erleichtern.

Seiteneinstellungen

Die Datei src/docs/config/siteSettings.json.ts wird zur Konfiguration der Seiteneinstellungen verwendet. Dazu gehoeren Optionen wie View-Transitions, Animationen und ob Kopierlink-Buttons fuer Dokumentationsueberschriften angezeigt werden sollen.

Seitendaten

Die Datei src/docs/config/[language]/siteData.json.ts wird zur Konfiguration der Seitendaten verwendet. Dazu gehoeren der Seitentitel, die Beschreibung, soziale Links und das Standardbild.

Navigationsdaten

Konfigurieren Sie Ihre Navigationsdaten fuer die obere Navigationsleiste in der Datei src/docs/config/[language]/navData.json.ts.

Seitenleisten-Layout

Konfigurieren Sie die Reihenfolge Ihrer Dokumentationsabschnitte in der Datei src/docs/config/[language]/sidebarNavData.json.ts.

Robots

Damit Suchmaschinen wie Google die korrekte Sitemap sehen, bearbeiten Sie die Datei public/robots.txt mit Ihrer Website-Domain.

Weitere Ressourcen

Allgemeine Astro-Informationen

Astro sucht nach .astro- oder .md-Dateien im Verzeichnis src/pages/. Jede Seite wird als Route basierend auf ihrem Dateinamen bereitgestellt.

Es gibt nichts Besonderes am Verzeichnis src/components/, aber dort werden ueblicherweise Astro/React/Vue/Svelte/Preact-Komponenten abgelegt.

Statische Assets wie Bilder koennen im Verzeichnis public/ platziert werden. Haeufig wird auch src/assets fuer Bilder verwendet, wenn Astro-Assets zur Bildoptimierung genutzt werden.

Befehle

Alle Befehle werden vom Stammverzeichnis des Projekts aus in einem Terminal ausgefuehrt:

Befehl	Aktion
npm install	Abhaengigkeiten installieren
npm run dev	Lokalen Entwicklungsserver starten auf localhost:4321
npm run build	Produktionsseite nach ./dist/ bauen
npm run preview	Build lokal vor dem Deployment ansehen
npm run astro ...	CLI-Befehle wie astro add, astro check ausfuehren
npm run astro -- --help	Hilfe zur Astro CLI erhalten

Mehr erfahren?

Schauen Sie sich die Dokumentation an oder besuchen Sie den Discord-Server.