Miksi se on olemassa
Tarjoamme dokumentaatioon keskittyvän sovelluksen, joka osoittaa, että CMS:n hallitsema sisältö voidaan muuttaa viimeistellyksi dokumentaatiosivustoksi ilman renderöintikerroksen uudelleenrakentamista.
Käytä tätä kun
- isännöit tuotteen dokumentaatiota CMS-sisällön päällä
- renderöit markdown-painotteisia dokumentteja
- rakennat sivupalkki- ja hakuvetoista dokumentaationavigointia
Mitä se sisältää
- dokumentaatiopohjan Next.js-sovellus
- CMS:ään perustuva catch-all-reittien renderöinti
- dokumentaation markdown-rajaus
- dokumentaatioon erikoistetut navigointipalkki-, sivupalkki- ja sisältökomponentit
- kielitietoinen artikkelien ja kategorioiden lataus
Perustyönkulku
- Määritä dokumentaatiosovellus CMS:n ympäristömuuttujilla.
- Renderöi dokumentaatioreitit
cms-renderer-työkalulla. - Nouda kategoria- ja artikkelidokumentit CMS-skeemoista.
- Renderöi markdown-sisältö dokumentaatioon tarkoitetuilla komponenteilla.
- Lisää päälle monipuolisempi navigointi ja haku.
Järjestelmän osa-alueet
- dokumentaatiosovelluksen reittikerros
- dokumentaatiosovelluksen käyttöliittymäkomponenttikerros
- dokumentaatiosovelluksen CMS-data- ja URL-apurit