Warum es existiert
Wir bieten eine dokumentationsorientierte Anwendung, die zeigt, dass CMS-verwaltete Inhalte ohne eine Neuerstellung der Rendering-Schicht in eine anspruchsvolle Dokumentationsseite verwandelt werden können.
Verwenden Sie dies, wenn
- Produktdokumentation auf Grundlage von CMS-Inhalten hosten
- markdownlastige Dokumente rendern
- eine von Seitenleiste und Suche gesteuerte Dokumentationsnavigation aufbauen
Was enthalten ist
- Next.js-App für das Docs-Template
- Rendering von Catch-all-Routen mit CMS-Unterstützung
- Markdown-Grenze für Dokumentationen
- dokumentationsspezifische Komponenten für Navigationsleiste, Seitenleiste und Inhalte
- sprachsensitives Laden von Beiträgen und Kategorien
Kernablauf
- Konfigurieren Sie die Docs-App mit den CMS-Umgebungsvariablen.
- Rendern Sie Dokumentationsrouten über
cms-renderer. - Rufen Sie Kategorien- und Beitragsdokumente aus den CMS-Schemata ab.
- Rendern Sie Markdown-Inhalte mit dokumentationsspezifischen Komponenten.
- Legen Sie zusätzliche Navigation und Suche darüber.
Systemoberflächen
- Routenebene der Docs-App
- UI-Komponentenebene der Docs
- CMS-Daten- und URL-Helfer für Docs