Proč existuje
Poskytujeme na dokumentaci zaměřenou aplikaci, která dokazuje, že obsah spravovaný v CMS lze přeměnit v profesionální web s dokumentací bez nutnosti znovu vytvářet vykreslovací vrstvu.
Kdy ji použít
- hostování produktové dokumentace nad obsahem z CMS
- vykreslování dokumentů s rozsáhlým použitím Markdownu
- vytváření navigace pro dokumentaci založené na postranním panelu a vyhledávání
Co obsahuje
- aplikace Next.js docs-template
- vykreslování catch-all tras podporovaných CMS
- hranice Markdownu pro dokumentaci
- komponenty navigační lišty, postranního panelu a obsahu specifické pro dokumentaci
- načítání příspěvků a kategorií s ohledem na jazyk
Základní pracovní postup
- Nakonfigurujte aplikaci dokumentace pomocí proměnných prostředí CMS.
- Vykreslete trasy dokumentace prostřednictvím
cms-renderer. - Načtěte dokumenty kategorií a příspěvků ze schémat CMS.
- Vykreslete obsah Markdownu pomocí komponent specifických pro dokumentaci.
- Navrch přidejte bohatší navigaci a vyhledávání.
Systémové vrstvy
- vrstva tras aplikace dokumentace
- vrstva komponent uživatelského rozhraní dokumentace
- pomocníci pro data CMS a adresy URL dokumentace