Using Components

Dockit bietet mehrere Komponentenoptionen zum Erstellen umfangreicher, interaktiver Dokumentation. Sie haben Zugriff sowohl auf die integrierten Komponenten von Astro Starlight als auch auf eine Sammlung benutzerdefinierter vorgefertigter Komponenten.

Astro Starlight Components

Sie können alle leistungsstarken Komponenten verwenden, die im Astro Starlight-Framework enthalten sind. Dazu gehören Karten, Abzeichen, Codeblöcke, Tabs und viele andere nützliche Dokumentationselemente.

Eine vollständige Dokumentation und Anwendungsbeispiele aller verfügbaren Starlight-Komponenten finden Sie unter: https://starlight.astro.build/components/using-components/

Dockit Premade Components

Zusätzlich zu den Starlight-Komponenten umfasst Dockit eine Sammlung maßgeschneiderter Komponenten, die speziell für Dokumentationsanforderungen entwickelt wurden. Alle diese Komponenten befinden sich im Ordner user-components.

Available Custom Components

Die folgenden vorgefertigten Komponenten stehen für die Verwendung in Ihrer Dokumentation zur Verfügung:

• Accordion – Reduzierbare Inhaltsabschnitte zum Organisieren von Informationen
• Button – Anpassbare Schaltflächenelemente mit verschiedenen Stilen
• Grid – Flexibles Rasterlayoutsystem zum Organisieren von Inhalten
• ListCard – Kartenbasierte Listen zur Präsentation von Funktionen oder Artikeln
• NewCard – Verbesserte Kartenkomponente mit modernem Design

Jede Komponente verfügt über eine eigene detaillierte Dokumentationsseite mit Anwendungsbeispielen, Requisiten und Best Practices.

Component Location

Alle benutzerdefinierten Komponenten sind in der folgenden Struktur organisiert:

src/
  components/
    user-components/     ← Main custom components
      ├── Accordion.astro
      ├── Button.astro
      ├── Grid.astro
      ├── ListCard.astro
      └── NewCard.astro

Getting Started

• Für Starlight-Komponenten: Weitere Informationen finden Sie in der oben verlinkten offiziellen Starlight-Dokumentation
• Für benutzerdefinierte Komponenten: Jede Komponente im Ordner user-components kann importiert und direkt in Ihren MDX-Dateien verwendet werden
• Komponentenanpassung: Alle Komponenten können an Ihre spezifischen Designanforderungen angepasst werden

Wählen Sie die Komponenten aus, die Ihren Dokumentationsanforderungen am besten entsprechen, und erstellen Sie ansprechende, interaktive Inhalte für Ihre Benutzer.