Site-Einstellungen

Das Dokumentationstheme lässt sich über verschiedene Site-Einstellungen anpassen. Diese Einstellungen steuern unterschiedliche Aspekte der Funktionalität und des Erscheinungsbilds.

Konfigurationsoptionen

copyLinkButtons

• Typ: boolean
• Standard: true

Steuert die Sichtbarkeit der „Link kopieren”-Buttons neben Überschriften auf Dokumentationsseiten. Wenn aktiviert, können Nutzer:innen mühelos direkte Links zu bestimmten Abschnitten deiner Dokumentation kopieren.

useViewTransitions

• Typ: boolean
• Standard: false

Steuert, ob Astros View-Transitions-API für Seitenübergänge aktiviert wird. Bei der Verwendung von Tailwind v4 im Entwicklungsmodus kann das Aktivieren dieser Option zu visuellem Stottern führen. In Produktions-Builds scheint das kein Problem zu sein.

pagination

• Typ: boolean
• Standard: true

Steuert die Sichtbarkeit der Navigationsbuttons „Zurück” und „Weiter” auf Dokumentationsseiten.

docsRoute

• Typ: string
• Standard: docs

Damit kannst du den Standard-Pfad für die Dokumentationsseiten ändern. Die Einstellung aktualisiert diverse Links und Routen innerhalb des Dokumentationsthemes, sodass sie dem angegebenen Pfad entsprechen.

Beispielkonfiguration

export const siteSettings: DocsSiteSettingsProps = {
  useViewTransitions: false,  // View-Transitions deaktivieren
  copyLinkButtons: true,     // Link-kopieren-Buttons an Dokumentations-Überschriften anzeigen
  docsRoute: "my-docs-route",         // Standard-Pfad für die Dokumentationsseiten ändern
};