Dlaczego istnieje
Udostępniamy aplikację skoncentrowaną na dokumentacji, która udowadnia, że treści zarządzane przez CMS można przekształcić w dopracowaną witrynę dokumentacyjną bez przebudowy warstwy renderowania.
Użyj tego, gdy
- hostujesz dokumentację produktu na bazie treści CMS
- renderujesz dokumenty bogate w Markdown
- tworzysz nawigację dokumentacji opartą na pasku bocznym i wyszukiwaniu
Co zawiera
- aplikację Next.js docs-template
- renderowanie tras catch-all oparte na CMS
- granicę Markdown dokumentacji
- komponenty paska nawigacyjnego, paska bocznego i treści specyficzne dla dokumentacji
- ładowanie postów i kategorii z uwzględnieniem języka
Kluczowy przebieg pracy
- Skonfiguruj aplikację dokumentacji za pomocą zmiennych środowiskowych CMS.
- Renderuj trasy dokumentacji przez
cms-renderer. - Pobierz dokumenty kategorii i postów ze schematów CMS.
- Renderuj treści Markdown za pomocą komponentów specyficznych dla dokumentacji.
- Dodaj na wierzchu bardziej rozbudowaną nawigację i wyszukiwanie.
Elementy systemu
- warstwa tras aplikacji dokumentacji
- warstwa komponentów interfejsu dokumentacji
- narzędzia pomocnicze dokumentacji do danych CMS i adresów URL
