Dlaczego istnieje
Udostępniamy aplikację ukierunkowaną na dokumentację, która udowadnia, że zarządzane przez CMS treści można przekształcić w dopracowaną witrynę dokumentacyjną bez przebudowywania warstwy renderowania.
Użyj, gdy
- hostujesz dokumentację produktu na treściach z CMS
- renderujesz dokumenty oparte głównie na Markdownie
- tworzysz nawigację po dokumentacji opartą na pasku bocznym i wyszukiwaniu
Co zawiera
- aplikacja Next.js docs-template
- renderowanie tras typu catch-all oparte na CMS
- granica Markdown dokumentacji
- dedykowane dla dokumentacji komponenty paska nawigacyjnego, paska bocznego i treści
- ładowanie postów i kategorii z uwzględnieniem języka
Podstawowy przebieg pracy
- Skonfiguruj aplikację dokumentacji za pomocą zmiennych środowiskowych CMS.
- Renderuj trasy dokumentacji za pomocą
cms-renderer. - Pobierz dokumenty kategorii i postów ze schematów CMS.
- Renderuj treści w Markdownie przy użyciu komponentów dedykowanych dokumentacji.
- Dodaj bogatszą nawigację i wyszukiwanie na wyższej warstwie.
Warstwy systemu
- warstwa tras aplikacji dokumentacyjnej
- warstwa komponentów interfejsu dokumentacji
- warstwa danych CMS dokumentacji oraz pomocników URL