Warum es existiert
Wir stellen eine dokumentationsorientierte Anwendung bereit, die zeigt, dass CMS-verwaltete Inhalte in eine hochwertige Dokumentationsseite verwandelt werden können, ohne die Rendering-Schicht neu aufzubauen.
Verwenden Sie dies, wenn
- Produktdokumentation auf Basis von CMS-Inhalten hosten
- Markdown-lastige Dokumente rendern
- Seitenleisten- und suchbasierte Dokumentationsnavigation erstellen
Was enthalten ist
- Next.js-App „docs-template“
- CMS-gestütztes Rendering für Catch-all-Routen
- Markdown-Abgrenzung für die Dokumentation
- Dokumentationsspezifische Navbar-, Sidebar- und Inhaltskomponenten
- Sprachsensitives Laden von Beiträgen und Kategorien
Kernablauf
- Konfigurieren Sie die Docs-App mit CMS-Umgebungsvariablen.
- Rendern Sie Docs-Routen über
cms-renderer. - Rufen Sie Kategorie- und Beitragsdokumente aus CMS-Schemas ab.
- Rendern Sie Markdown-Inhalte mit dokumentationsspezifischen Komponenten.
- Ergänzen Sie darauf aufbauend eine umfassendere Navigation und Suche.
Systemoberflächen
- Routenebene der Docs-App
- UI-Komponentenebene der Docs-App
- CMS-Daten- und URL-Hilfen für die Docs
